From 705799720aaae30535e4a7ad72a938c995c5da6a Mon Sep 17 00:00:00 2001 From: permui Date: Mon, 3 Oct 2022 15:33:02 +0800 Subject: [PATCH] add readme --- Readme.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..7254903 --- /dev/null +++ b/Readme.md @@ -0,0 +1,18 @@ +# PPL Lab Packer + +This program packs and encrypts your codes for submission. + +More specifically, when you run `pack` in directory `proj`, +it will only pack the following files and directories, if they exist. + +* files + * `proj/dune-project` + * `proj/*.opam` +* directories + * `proj/lib` + * `proj/bin` + * `proj/test` + +Such restrictions make uploads slim and without redundant files. + +It produces a PGP message `stu-code.pgp.txt`. \ No newline at end of file