mirror/becarpenter-book6
1
0
Fork 0
mirror of https://github.com/becarpenter/book6.git synced 2024-05-07 02:54:53 +00:00
Code Releases Activity

Added usage note

Browse Source
This commit is contained in:
Brian E Carpenter
2024-04-28 16:42:59 +12:00
committed by GitHub
parent e2a37499ab
commit 8d3c0a6f32
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
utilities/utDoc.md
View File

@ -1,5 +1,21 @@
## The book6 utilities
### Usage note
All the utilities are written in Python 3 and should work on most common
operating systems (but have mainly been tested on Windows 10). They mainly
use `tkinter` to provide a nice user interface with options. If invoked on
the command line with the book6 directory path as a parameter, they will
run with default options. For example:
```
python3 makeBook.py
```
will get you a GUI, but
```
python3 makeBook.py ~/whatever/book6
```
will just run.
### makeBook
This program is applied to the entire book6 directory
@ -170,5 +186,7 @@ A necessary hack is that where a page break is needed,
this is signaled by a dummy line: `backslashpagebreak`.
This is converted later to a genuine pagebreak.
Conversion to an eBook format is under investigation.
Further info is in the `pdf` directory.