doohoyi/zine_maker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
mara 2021-12-10 00:54:40 +01:00
parent 2bc8eae99c
commit f7e33cf49d
1 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,9 +1,12 @@
## To Download the project, under the blue vertical line, click on the download icon next to "WEB IDE". ## To Download the project, near the top of the page, click on the download icon next to "WEB IDE".
You can choose which type of archived folder you want, and then open it in your filesystem. You can choose which type of archived folder you want, and then open it in your filesystem.
## OR use git clone: ## OR use git clone:
```
git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker.git git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker.git
cd zine_maker cd zine_maker
```
## Requirements ## Requirements
You need either python2 or python3 running on the computer You need either python2 or python3 running on the computer
@ -11,47 +14,47 @@ https://www.python.org/downloads/
And also the pip command And also the pip command
https://pip.pypa.io/en/stable/installation/ https://pip.pypa.io/en/stable/installation/
Once these are installed, from within zine_maker run: Once these are installed, from within zine_maker run:
pip install -r requirements.txt `pip install -r requirements.txt`
## For merging the cover.pdf, body.pdf and colophon.pdf there are many pdf merger tools, ## For merging the cover.pdf, body.pdf and colophon.pdf there are many pdf merger tools,
one that is command line based is pdfunite one that is command line based is pdfunite
http://linux-commands-examples.com/pdfunite http://linux-commands-examples.com/pdfunite
from the terminal run: from the terminal run:
pdfunite cover.pdf body.pdf colophon.pdf output.pdf `pdfunite cover.pdf body.pdf colophon.pdf output.pdf`
## For shuffling the final pdf and prepare it for printing you need the pdfseparate command ## For shuffling the final pdf and prepare it for printing you need the pdfseparate command
http://www.linux-commands-examples.com/pdfseparate http://www.linux-commands-examples.com/pdfseparate
it is used inside the shuffle_pdf.py file (see details at the end of Readme) it is used inside the shuffle_pdf.py file (see details at the end of this Readme)
## For making use of images in the script, image magick needs to be installed ## For making use of images in the script, image magick needs to be installed
http://www.imagemagick.org/ http://www.imagemagick.org/
## To make the content of the pdf ## To make the content of the pdf
python doc_pdf.py `python doc_pdf.py `
OR OR
python doc_pdf.py text/images.txt body/images.pdf `python doc_pdf.py text/images.txt body/images.pdf`
OR add your text file and replace respectively OR add your text file and replace respectively
python doc_pdf.py text/<your_file>.txt body/<output-name>.pdf `python doc_pdf.py text/<your_file>.txt body/<output-name>.pdf`
## To make the cover of the pdf ## To make the cover of the pdf
python cover.py `python cover.py`
OR OR
python cover.py text/cover.txt covers/cover.pdf `python cover.py text/cover.txt covers/cover.pdf`
OR add your text file and replace respectively OR add your text file and replace respectively
python cover.py text/<your-cover>.txt covers/<cover-name>.pdf `python cover.py text/<your-cover>.txt covers/<cover-name>.pdf`
## To make the colophon of the pdf ## To make the colophon of the pdf
python cover.py `python cover.py `
OR OR
python cover.py text/colophon.txt colophones/colophon.pdf `python cover.py text/colophon.txt colophones/colophon.pdf`
OR add your text file and replace respectively OR add your text file and replace respectively
python cover.py text/<your-colophon>.txt colophones/<output-colophon>.pdf `python cover.py text/<your-colophon>.txt colophones/<output-colophon>.pdf`
## To prepare signatures for printing a small booklet ## To prepare signatures for printing a small booklet
python shuffle_pdf.py final.pdf final_shuffled.pdf `python shuffle_pdf.py final.pdf final_shuffled.pdf`