update readme

This commit is contained in:
2021-08-23 11:19:19 +02:00
parent 8d35571fb8
commit 09ff5e8823

View File

@@ -2,11 +2,15 @@
To get started, make sure you have `git`, `cargo` and, `rustc` installed and available.
git clone https://github.com/pbsds/gloom-rs
## Report
You're free to write your report any way you'd like, as long as it is delivered as a PDF file.
To spread the word of *the one true way*, I have included a `pandoc` report skeleton in the `report` folder.
To use it make sure you have `pandoc` installed along with a supported latex engine, and make sure it works before using it to write your report.
To use it make sure you have `pandoc` installed along with a latex engine.
Make sure it works before using it to write your report.
## Code delivery