diff --git a/README.md b/README.md new file mode 100644 index 0000000..c9777a3 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Final Report + +This is a huge document that is a combination of a large number +of other files from this course. + +This repository avoids commiting PDFs whenever possible (some files' +original sources have been lost, and thus, only a PDF is available). +Thus, LaTeX sources of all possible documents are submoduled, +and compiled at build time. + +Some components of this document are generated from previously +commited Markdown files to avoid redundancy. In particular, +READMEs from all the code repositories and the REVIEW files +containing code review feedback are used. + +For the most part (you still need to clone submodules), +I specified the dependencies of this project in a Nix expression. +Thus, to build this whole PDF: + +``` +nix-shell +make +``` + +This should install all the required LaTeX packages and Pandoc, +and generate an `archive.pdf` file. diff --git a/default.nix b/default.nix index f5ec924..1f4c1ac 100644 --- a/default.nix +++ b/default.nix @@ -3,8 +3,14 @@ with import {}; mkShell { buildInputs = [ pandoc - (python38.withPackages (ps: with ps; [ pip virtualenv ])) - (texlive.combine { inherit (texlive) listings framed booktabs pdfjam pdfpages pdflscape scheme-basic IEEEtran collection-fontsrecommended todonotes caption pgfgantt setspace; }) + (texlive.combine { + inherit (texlive) + listings framed booktabs + pdfjam pdfpages pdflscape + scheme-basic IEEEtran + collection-fontsrecommended + todonotes caption pgfgantt + setspace; }) ]; }