Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
edwinjosegeorge committed Nov 26, 2021
1 parent 892c0ec commit d4cd11f
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit d4cd11f

Please sign in to comment.