Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-11-04 03:27:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'manual' of https://github.com/felagund/calibre

Browse Source
This commit is contained in:
Kovid Goyal 2022-06-18 05:35:47 +05:30
commit 3d41dde21c
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
manual/develop.rst
View File

@ -157,8 +157,8 @@ Windows development environment
.. note:: You must also get the calibre source code separately as described above. .. 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 <https://calibre-ebook.com/download_windows>`__.
the previously checked out calibre code folder. For example:: Then open a Command Prompt and change to the previously checked out calibre code folder. For example::
cd C:\Users\kovid\work\calibre cd C:\Users\kovid\work\calibre
@ -191,8 +191,8 @@ macOS development environment
.. note:: You must also get the calibre source code separately as described above. .. 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 <https://calibre-ebook.com/download_osx>`__.
the previously checked out calibre code folder, for example:: Then open a Terminal and change to the previously checked out calibre code folder, for example::
cd /Users/kovid/work/calibre cd /Users/kovid/work/calibre
@ -202,7 +202,8 @@ The calibre command line tools are found inside the calibre app bundle, in
you should add this folder to your PATH environment variable, if you want to you should add this folder to your PATH environment variable, if you want to
run the command line tools easily. run the command line tools easily.
The next step is to create a bash script that will set the environment variable ``CALIBRE_DEVELOP_FROM`` to the absolute path of the src folder when running calibre in debug mode. The next step is to create a bash script that will set the environment variable ``CALIBRE_DEVELOP_FROM``
to the absolute path of the src folder when running calibre in debug mode.
Create a plain text file:: Create a plain text file::
@ -233,7 +234,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 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. 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 <https://calibre-ebook.com/download_linux>`_. Then open a terminal and change to the previously checked out calibre code folder, for example::
cd /home/kovid/work/calibre cd /home/kovid/work/calibre
@ -243,6 +244,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 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. 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 Once you have set the environment variable, open a new terminal and check that it was correctly set by using
the command:: the command::