Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Governing Documents

The constitution and bylaws for the ML Paper Reading Group (Augusta University), written in LaTeX.

Document Source Output (after build)
Constitution constitution.tex build/constitution.pdf
Bylaws bylaws.tex build/bylaws.pdf

Building

Pick the Makefile for your platform and copy it to Makefile (which is gitignored, so your choice won't be committed):

# Linux (uses latexmk + a TeX distribution)
cp Makefile.linux Makefile

# macOS (uses tectonic)
cp Makefile.mac Makefile

Then build:

make all            # build both PDFs into build/
make constitution   # build constitution.pdf only
make bylaws         # build bylaws.pdf only
make open           # build + open the constitution
make open-bylaws    # build + open the bylaws
make clean          # remove build output
make help           # list all targets

Live rebuild while editing

make watch          # rebuild constitution on change
make watch-bylaws   # rebuild bylaws on change

On Linux this uses latexmk -pvc. On macOS it uses fswatch (brew install fswatch).

Toolchain

  • Linux: latexmk plus a TeX distribution (e.g. TeX Live: sudo apt install texlive-full or a smaller subset).
  • macOS: Tectonic (brew install tectonic) — self-contained, downloads packages on demand.

Either toolchain works on either OS; the split just reflects the most common setup for each. CI builds with Tectonic.

Continuous integration

.github/workflows/build.yml builds both PDFs on every push to main and on pull requests, and uploads them as a downloadable artifact named documents. A failed build (e.g. a LaTeX error) fails the check.

License

See UNLICENSE.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages