From f6d9611a5f4d71d1a08ef8ee93e1de5e38de9161 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Hnyk?= Date: Fri, 17 Jun 2022 23:18:02 +0200 Subject: [PATCH] Clarifies which Linux package to use This adds two things to documentations: 1. Links to installers (I picked the non 64bit version for Windows) 2. Clarifying and emphasazing that one needs to use package used by upstream to use CALIBRE_DEVELOP_FROM, not the package provided by distribution See also here: https://www.mobileread.com/forums/showthread.php?t=294791 --- manual/develop.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/manual/develop.rst b/manual/develop.rst index 3c78c20ff8..d1ebd18759 100644 --- a/manual/develop.rst +++ b/manual/develop.rst @@ -157,7 +157,7 @@ Windows development environment .. note:: You must also get the calibre source code separately as described above. -Install calibre normally, using the Windows installer. Then open a Command Prompt and change to +Install calibre normally, using the `Windows installer `_. Then open a Command Prompt and change to the previously checked out calibre code folder. For example:: cd C:\Users\kovid\work\calibre @@ -191,7 +191,7 @@ macOS development environment .. note:: You must also get the calibre source code separately as described above. -Install calibre normally using the provided .dmg. Then open a Terminal and change to +Install calibre normally using the `provided .dmg `_. Then open a Terminal and change to the previously checked out calibre code folder, for example:: cd /Users/kovid/work/calibre @@ -233,7 +233,7 @@ used in Windows and macOS. Alternatively, you can install calibre from source. I environment from source are in the INSTALL file in the source tree. Here we will address using the binary as a runtime, which is the recommended method. -Install calibre using the binary installer. Then open a terminal and change to the previously checked out calibre code folder, for example:: +Install calibre using the `binary installer `_. Then open a terminal and change to the previously checked out calibre code folder, for example:: cd /home/kovid/work/calibre @@ -243,6 +243,11 @@ The next step is to set the environment variable ``CALIBRE_DEVELOP_FROM`` to the So, following the example above, it would be ``/home/kovid/work/calibre/src``. How to set environment variables depends on your Linux distribution and what shell you are using. +.. note:: + It is recommended to use the binary installer provided from upstream. + Should you insist on using a package provided by your distribution, use + the ``CALIBRE_PYTHON_PATH`` and ``CALIBRE_RESOURCES_PATH`` variables instead. + Once you have set the environment variable, open a new terminal and check that it was correctly set by using the command::