From 2bc8eae99cca86281805ada4db8ce180f4d42771 Mon Sep 17 00:00:00 2001
From: mara <mara@multiplace.org>
Date: Fri, 10 Dec 2021 00:49:43 +0100
Subject: [PATCH] Add README.md

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c260d4d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+## To Download the project, under the blue vertical line, 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.
+
+## OR use git clone:
+git clone https://zine:DskM_8XxtKt-Wym1xHd1@git.systerserver.net/mara/zine_maker.git
+cd zine_maker
+
+## Requirements
+You need either python2 or python3 running on the computer
+https://www.python.org/downloads/
+And also the pip command 
+https://pip.pypa.io/en/stable/installation/ 
+Once these are installed, from within zine_maker run:
+pip install -r requirements.txt
+
+## For merging the cover.pdf, body.pdf and colophon.pdf there are many pdf merger tools,
+one that is command line based is pdfunite
+http://linux-commands-examples.com/pdfunite
+from the terminal run:
+pdfunite cover.pdf body.pdf colophon.pdf output.pdf
+
+## For shuffling the final pdf and prepare it for printing you need the pdfseparate command 
+http://www.linux-commands-examples.com/pdfseparate
+it is used inside the shuffle_pdf.py file (see details at the end of Readme)
+
+## For making use of images in the script, image magick needs to be installed
+http://www.imagemagick.org/
+
+## To make the content of the pdf 
+python doc_pdf.py 
+
+OR 
+python doc_pdf.py text/images.txt body/images.pdf
+
+OR add your text file and replace respectively
+python doc_pdf.py text/<your_file>.txt body/<output-name>.pdf
+
+## To make the cover of the pdf 
+python cover.py
+
+OR
+python cover.py text/cover.txt covers/cover.pdf
+
+OR add your text file and replace respectively
+python cover.py text/<your-cover>.txt covers/<cover-name>.pdf
+
+## To make the colophon of the pdf 
+python cover.py 
+
+OR
+python cover.py text/colophon.txt colophones/colophon.pdf
+
+OR add your text file and replace respectively
+python cover.py text/<your-colophon>.txt colophones/<output-colophon>.pdf
+
+## To prepare signatures for printing a small booklet
+python shuffle_pdf.py final.pdf final_shuffled.pdf
\ No newline at end of file