Initial commit

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d4e070
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# VG101-Grade-Helper
+
+A script that perform cast-to-cast VG101 grading for UMJI VG101FA2020-1.
+
+It helps you begin from clone repo from Gitea to giving grade to canvas with comment of rubric.
+
+## Installation & Usage
+
+```bash
+$ pip3 install -r requirement.txt
+$ mv hgroups.example.json hgroups.json
+$ vim hgroups.json
+$ mv settings.example.py settings.py
+$ vim settings.py
+$ ./VG101GradeHelper.py --help
+usage: VG101GradeHelper.py [--help] [-h HW] [-p PROJ] [-m MS] [-a] [-s] [-t] [-i] [-g] [-j] [-u]
+
+optional arguments:
+  --help                show this help message and exit
+  -h HW, --hw HW        # homework
+  -p PROJ, --proj PROJ  # project
+  -m MS, --ms MS        # milestone
+  -a, --all             check all
+  -s, --score           generate score
+  -t, --tidy            check tidy
+  -i, --indv            check indiviual submission
+  -g, --group           check group submission
+  -j, --joj             check joj score
+  -u, --upload          upload score to canvas
+```
+
+Please modify `JOJ_INFO` for different homework.
+
+### Example
+
+#### For homework
+
+```bash
+./VG101GradeHelper.py -h1 -au
+```
+
+#### For project
+
+```bash
+./VG101GradeHelper.py -p1 -m1
+```
+
+## Features
+
+- [x] At least two days before the group deadline, all students should individually complete all the mandatory tasks and push their work to their personal branch of their group git repository and issue a pull request. Students late for the individual submission must open an issue featuring: (i) apologies to the reviewer, (ii) clear explanations on why the work is late, and (iii) a request for a new deadline fitting the reviewer. The reviewer is allowed to reject the request and should set the deadline based on his/her own schedule. (-0.5 mark)
+- [ ] A student should provide feedbacks to at least one teammate for each mandatory exercise. Low quality reviews will be ignored. Each student should receive feedbacks on his individual submission. e.g. for a three students group: student1 → student2 → student3 → student1. (-1 mark)
+- [ ] The final group submission, done on the master branch of the group repository, should successfully compile or be interpreted. (-1 mark)
+- [x] Any group submission that is more than 24 hours late will be rejected. (-2.5 marks)
+- [x] For each exercise, the final submission must pass at least 25% of the test cases. (-0.25 mark per exercise, up to -0.5)
+- [x] For a homework the final submission must pass at least 50% of all the test cases. (-0.5 mark)
\ No newline at end of file