From f1a691296ba63776bb4d9b7e40642af29ab10488 Mon Sep 17 00:00:00 2001 From: LailaTheElf Date: Sun, 9 Feb 2025 21:42:31 +0100 Subject: [PATCH] inital commit --- .gitignore | 3 + converters/mdToLatex.sh | 123 ++++++++++++++++++++++++++++++++++++ makefile | 20 ++++++ markdown/plan_van_aanpak.md | 105 ++++++++++++++++++++++++++++++ readme.md | 21 ++++++ 5 files changed, 272 insertions(+) create mode 100644 .gitignore create mode 100644 converters/mdToLatex.sh create mode 100644 makefile create mode 100644 markdown/plan_van_aanpak.md create mode 100644 readme.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..180a4d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/latex +/pdf +/build diff --git a/converters/mdToLatex.sh b/converters/mdToLatex.sh new file mode 100644 index 0000000..31925fe --- /dev/null +++ b/converters/mdToLatex.sh @@ -0,0 +1,123 @@ +MD_FILE="$1" +TEX_FILE="$2" +BUILD_DIR="$3" + +TEMP_MD_FILE="$BUILD_DIR/$(basename "$MD_FILE")" +TEMP_TEX_FILE="$BUILD_DIR/$(basename "$MD_FILE" | sed -e 's|md$|latex|')" +mkdir -p "$(dirname "$TEMP_MD_FILE")" + +title="$(grep '^# ' "$MD_FILE" | sed 's|^# ||')" + +cat "$MD_FILE" | sed \ + -e 's|\[toc\]|\\tableofcontents|' \ + -e 's|^\[parent\].*$||' \ + -e 's|^# .*$||' \ + -e 's|^#||' \ + >"$TEMP_MD_FILE" + +CUR_DIR="$(pwd)" +cd "$BUILD_DIR" +pandoc --to=latex -o "$(basename "$TEMP_TEX_FILE")" "$(basename "$TEMP_MD_FILE")" +cd "$CUR_DIR" + +cat >"$TEX_FILE" <>"$TEX_FILE" +cat >>"$TEX_FILE" < TODO: nog een leuk intro praatje toevoegen + +### Analyse fase + +In de analyse fase worden de volgende documenten opgesteld: + +- **Plan van Aanpak** +Dit document. + +- **Risico analyse** +Hier worden alle risico's beschreven en wat we doen om de risico's te verminderen. + +- **Pakket van eisen** +Hier worden alle eisen waar het product aan moet gaan voldoen + +- **Globale planning** +Zie hoofdstuk ... + +- **Functioneel prototype?** +Een prototype om te controleren of het concept mogelijk en realistisch is. + +### Ontwerp fase + +- testprocedures +- het ontwerp van het product +- bom + +### test fase + +- test raporten + +## Kwaliteit + +## Planning + +Er worden twee niveaus aan van planningen gemaakt: globale planning en een detail planning. De globale planning worden de grotere lijnen van het project geplant. Het doel is om te zorgen dat de hele groep weet wanneer andere onderdelen klaar zijn om de onderdelen met elkaar te kunnen testen. + +De detailplanning is voor het plannen van deze onderdelen. Elk onderdeel zal een beperkt aantal ingenieurs aan werken, deze ingenieurs houden zelf deze planning bij. + +Elke week komt de groep samen op donderdag om de planningen door te nemen en waar nodig aanpassingen maken. + +De globale planning is te vinden in de [bijlagen] + +## Kosten en baten + +## Risico’s + +## Bijlage + +### Globale Planning + + + +### Risico analyse + + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..04e75e2 --- /dev/null +++ b/readme.md @@ -0,0 +1,21 @@ +# PEE51 Formula Student - documentatie + +Alle documentatie wordt gemaakt in Markdown en met *Pandoc* geconverteerd naar LaTeX en vervolgens met *TeXLive* (*XeLaTeX*) omgezet naar pdf. + +## Converteren + +Met *Make* kunnen alle documenten geconverteerd worden. Hier worden tools gebruikt die alleen in Linux beschikbaar zijn. In de make file is een target `install` die deze tools installeert, dit werkt alleen op Arch Linux. Deze installatie kun je runnen met het volgende commando. + +> NOTE: de installer is nog niet compleet, het [Ubuntu font](https://design.ubuntu.com/font) ontbreekt nog in de installer en moet dus handmatig geïnstalleerd worden. + +```sh +sudo make install +``` + +Als alles is geinstalleerd kan er met het volgende comando alle documenten naar pdf geconverteerd. + +> LETOP: Het kan zijn dat dit comando meerdere malen herhaald moet worden zodat in inhouds opgaven corect is. Controleer hier ook de de pagina nummers. + +```sh +make all +```