diff --git a/README.md b/README.md index e1d2b09..7c7452d 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,24 @@ [![CI](https://github.com/robocek/By-Law/actions/workflows/main.yml/badge.svg)](https://github.com/robocek/By-Law/actions/workflows/main.yml) Guidelines for ROBOCEK student execom + +## Prerequisites +Download and install [`Git`](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [`Latex`](https://latex-tutorial.com/installation/) + + To clone this repo + ```bash + git clone https://github.com/robocek/By-Law.git + ``` + + To get the latest works, pull the updates + ```bash + git pull + ``` + + To Compile the Latex-record-book into `ByLaw.pdf` + ```bash + pdflatex ByLaw.tex + ``` + + ## Contributing changes + Each chapter has been written in its corresponding `.tex` file. Make changes as required in `.tex` file and compile to pdf using `pdflatex`