diff --git a/README b/README new file mode 100644 index 0000000..9fcc06e --- /dev/null +++ b/README @@ -0,0 +1,38 @@ + ACED PROJECT + +This repository is (part of) my work for the ``Arquitecturas de Elevado +Desempenho'' class. See the doc/proposal.pdf document for more information on +the problem statement. + + +[[Project Structure]] + +root + ├ aux Auxiliary scripts. + ├ contrib External C libraries. + ├ data Data for use as input or embedding in source. + ├ doc Extra documentation related to the project. + ├ includes Header files. + ├ obj Compiled object files. + └ src Root project source files. + +The directory is essentially a C project, with auxiliary documentation and +scripts. The main executable can be compiled by running the corresponding +[sane] recipe: + + python3 make.py compile + +This will produce a main.exe executable in the root directory. +See all available recipes by running + + python3 make.py --list + +and read more about [sane]: at https://github.com/mikeevmm/sane. + + +[[Use Instructions]] + +To use, pipe the input (structured according to the source specification) into +the executable. E.g., + + cat data/test_mat.txt | ./main.exe \ No newline at end of file diff --git a/doc/proposal.pdf b/doc/proposal.pdf new file mode 100644 index 0000000..2a3ddf5 Binary files /dev/null and b/doc/proposal.pdf differ