BFHS-Open Constitution

---

Table of Contents

1. Summary
2. Dependencies
3. Building
4. Continous Deployment
5. Contributing
6. Inspiration
7. Contributors
8. License

Summary

This is the version controlled repository for Benjamin Franklin Open's constitution.

This document is built in Latex and requires dependancies described here

To view the pre-built PDF of the constitution, check the Github releases, powered by Github Actions.

Project Organization:

...
├── .github
├── README.md
├── out
│   ├── constitution.pdf
│   └── ...
├── Makefile
├── LICENSE
├── constitution.tex
├── assets
│   └── bird.png
└── articles
    ├── article-10.tex
    ├── article-09.tex
    ├── article-08.tex
    ├── article-07.tex
    ├── article-06.tex
    ├── article-05.tex
    ├── article-04.tex
    ├── article-03.tex
    ├── article-02.tex
    └── article-01.tex

• README.md
  • The file you are currently reading.
• /out
  • Generated by the makefile to output the Latexmk output as to not pollute the main repository directory.
• Makefile
  • format - Runs prettier over /articles, should be ran before commiting.
  • build - Makes /out directory and runs Latexmk to build /out/constitution.pdf.
  • clean - Removes /out directory and contained files.
  • rebuild - Cleans /out and runs build.
  • open - Rebuilds /out/constitution.pdf and opens it through xdg-open
• LICENSE
  • Contains the license text for CC0.
• constitution.tex
  • Main latex file that calls in all the articles. Just run Latexmk on this file.
• /assets
  • Holds all images and other assets required for building the Latex file.
• /articles
  • Contains the individual articles.
• /.github
  • Location for github actions and pull-request/issue templates.

Dependencies:

• Latexmk
  • Required for building the PDFs from the Latex
• prettier & prettier-plugin-latex
  • Used by make format to automatically format the latex in a consistant style.
• GNU Make (or a compatable alternative)
• Texlive Latex & the following packages:
  • graphicx
  • hyperref

Building:

git clone https://github.com/bfhs-open/constitution
  
make build

Now you are able to view the PDF, found in ./out/constitution.pdf.

Continous Deployment:

This repository uses github actions to build new releases when a pull-request has been merged into main, thus achieving continuous deployment.

The Github Actions depend on:

• actions/checkout
• marvinpinto/action-automatic-releases

You can check the status of the Github Action here.

Contributing:

Follow the contributing guidelines described in Article 8 of the constitution.

Inspiration

UNO-Open Constitution

RITSEC Constitution

Contributors

License

License for Non-Logo

To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work.

Licensing for Logo

BFHS-Open retains all rights and does not offer a license for use of the Organization's Logo.