Design Documentation (team)
- make sure your design document is fully up to date, and update it if it's not
- try to make it look nice, there is a Markdown cheat sheet that you can use
-
generate a PDF file from your MD file, it can be done in different ways
-
VSCode extension
- install the extension
- open your MD file, right click on the file area and choose Markdown PDF: (Export pdf)
- a generated PDF file will be placed into the same directory as your MD file
-
Pandoc and MiKTex
- install Pandoc and MiKTex (you can use SE lab computers instead, they are already installed there)
-
go to your /doc directory and run mvn exec:exec@docs
- if you have issues on Mac, it may happen due to an issue described in the discussion. Therefore, the proposed solution may help
- you can generate Pandoc directly without Maven by running pandoc DesignDoc.md -o DesignDoc.pdf
-
online services
- there is a set of online tools available that you can find and use if you want, but be mindful about data privacy as the document contains your names
-
VSCode extension
Submission
Submit the generated PDF file to the assignment submission page on myCourses.