Merge pull request #2 from gpontesss/update-readme-with-building-instructions

Add instructions on how to build the document

Author: gpontesss

README.md

@@ -1,4 +1,4 @@
-![adornation](img/headers/bar18.svg)
+![adornation](img/headers/bar20.svg)
 
 # Russian Orthodox Prayer Book
 
@@ -12,6 +12,27 @@ Images were obtained from the [Orthodox Arts Journal] project. Since the
 repository's license allows for commercial usage, be aware that the [due credit
 should be given to the images](image-credit).
 
+## Building the project locally
+
+To build a project locally, the following dependencies are needed:
+
+* [XeTeX]: TeX's extension used;
+* [Inkscape]: For rendering SVG into images compatible with TeX;
+* [Python]: For running the script which installs the required fonts;
+* [GNU Make]: For building the document.
+
+To build the document:
+
+```sh
+# Installs required fonts
+./scripts/install-font.sh "Gentium Book Plus" "EB Garamond"
+# Builds the document
+make
+```
+
+If you have any doubts on minimal dependencies, take a look at the [build
+workflow] for an example of a setup from scratch.
+
 ## Acessing a release build
 
 Every build is available as an attached asset called `prayer-book.pdf` in its
@@ -22,3 +43,8 @@ recent build.
 [Jordanville edition]: https://www.ponomar.net/data/jordanville_prayerbook.pdf
 [Orthodox Arts Journal]: https://orthodoxartsjournal.org/orthodox-illustration-project/
 [image-credit]: https://docs.google.com/file/d/0B1MLai552F5yZkJIQ3B0QWx3cDA/view?rm=minimal&resourcekey=0-ybOjgmmviTqQOikbXOc9ag
+[XeTeX]: https://tug.org/xetex/
+[Inkscape]: https://inkscape.org/
+[GNU Make]: https://www.gnu.org/software/make/
+[Python]: https://www.python.org/
+[build workflow]: .github/workflows/build.yml