diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..af5aa2c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +* text=auto + +*.sh text eol=lf +*.bat text eol=crlf diff --git a/.gitignore b/.gitignore index e86f7e9..8aaf455 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ /.vscode /report/*.pdf /report/*.html +source.zip diff --git a/Makefile b/Makefile deleted file mode 100644 index dd5d3b8..0000000 --- a/Makefile +++ /dev/null @@ -1,12 +0,0 @@ -.PHONY: help -help: - @echo -e "List of make targets:\n" - @grep "^\.PHONY: " Makefile | cut -d" " -f2- | sed -e "s/ /\n/g" - -.PHONY: run -run: - cargo run - -.PHONY: report -report: - make -C report diff --git a/README.md b/README.md index f6955cd..d6bb7a1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ To get started, make sure you have `git`, `cargo` and, `rustc` installed and available. +## 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` with a supported latex engine installed, making sure it works before using it to write your report. +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. + +## Code delivery + +To make a code archive (`source.zip`) for uploading on blackboard run either `create_code_archive_for_blackboard_LINUX.sh` or `create_code_archive_for_blackboard_WINDOWS.bat`. diff --git a/create_code_archive_for_blackboard_LINUX.sh b/create_code_archive_for_blackboard_LINUX.sh old mode 100644 new mode 100755 index 6dee7b6..9e784ff --- a/create_code_archive_for_blackboard_LINUX.sh +++ b/create_code_archive_for_blackboard_LINUX.sh @@ -1 +1,2 @@ -zip -r source.zip gloom/src gloom/shaders +#!/bin/sh +zip -r source.zip src shaders Cargo.lock Cargo.toml diff --git a/create_code_archive_for_blackboard_WINDOWS.bat b/create_code_archive_for_blackboard_WINDOWS.bat index 8c77071..27ce3fd 100644 --- a/create_code_archive_for_blackboard_WINDOWS.bat +++ b/create_code_archive_for_blackboard_WINDOWS.bat @@ -1,2 +1,2 @@ -gloom/vendor/7z/7za.exe a source.zip gloom/src gloom/shaders +vendor/7za.exe a source.zip src shaders Cargo.lock Cargo.toml pause diff --git a/vendor/7za.exe b/vendor/7za.exe new file mode 100644 index 0000000..2bdd57d Binary files /dev/null and b/vendor/7za.exe differ