Skip to content

Commit

Permalink
change readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
paladhammika committed May 10, 2024
1 parent 1febbb8 commit fcf82c8
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.org → README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
#+TITLE: Pāli-English Recitations
div align="center">

# Pāli-English Recitations

A collaborative effort from the SBS Saṅgha and members of the greater community.

![Front Cover](./assets/illustrations/A5/front-cover.jpg)
<!-- ![Doom Emacs Screenshot](https://raw.githubusercontent.com/doomemacs/doomemacs/screenshots/main.png) -->

</div>

* Prerequisites
## Prerequisites
- make
- texlive (the complete TeXLive distribution is preferrable though you may be able to install only the needed binaries depending on your distribution or OS.)
- [[https://github.com/inotify-tools/inotify-tools][inotify-tools]]
Expand All @@ -14,7 +19,7 @@ A collaborative effort from the SBS Saṅgha and members of the greater communit
- [[https://github.com/w3c/epubcheck][epubcheck]]
- kindlegen

** LaTeX
## LaTeX
- [[https://www.ctan.org/pkg/tabularray][Tabularray]]
- [[https://www.ctan.org/pkg/ninecolors][Ninecolors]]

Expand All @@ -26,7 +31,7 @@ Linux: =/home/<your-username>/.local/share/texmf/tex=

Windows: =C:\Users\<your-username>\texmf\tex=

* =make= Commands
## =make= Commands
- =make pdf=: Tangles =recitations.tex.org= to the respective TeX files, builds the PDF, then renames and places the PDF in =build/= . =make pdf2x= does the same just twice over to ensure the hyperlinks are properly set.
- =make pdfrequirements=: Downloads the tabularray and ninecolors packages and places them in =$TEXMFHOME/tex=.
- =make epub=: Builds EPUB format; placed in =build/=.
Expand Down

0 comments on commit fcf82c8

Please sign in to comment.