README.md now belongs to Leningrade

1 files changed, 47 insertions, 59 deletions

diff --git a/README.md b/README.md
index 28d7711..a4c944f 100644
--- a/README.md
+++ b/README.md
@@ -1,67 +1,55 @@
-# VG101-Grade-Helper
+# Leningrade
+Because grades belong to everyone™
 
-A script that perform cast-to-cast VG101 grading for UMJI VG101FA2020-1.
+> N.B.: You will only need this tool if you are a UMJI (University of Michigan -
+> SJTU Joint Institute freshman student enrolling in VG101 or VG151.
 
-It helps you begin from clone repo from Gitea to giving grade to canvas with comment of rubric.
+> WARNING: NO WARRANTY OF ANY KIND. THE PROJECT IS NOT REMOTELY COMPLETE.
 
-## Installation & Usage
-
-First install [ctags](https://github.com/universal-ctags/ctags) for C code quality checking.
-
-```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] [-f FEEDBACK] [-m MS] [-r REJUDGE] [-a] [-s] [-t] [-d] [-i] [-g] [-j] [-u]
-
-optional arguments:
-  --help                show this help message and exit
-  -h HW, --hw HW        # homework
-  -p PROJ, --proj PROJ  # project
-  -f FEEDBACK, --feedback FEEDBACK
-                        give feedback to project
-  -m MS, --ms MS        # milestone
-  -r REJUDGE, --rejudge REJUDGE
-                        rejudge group num or stu ID
-  -a, --all             check all
-  -s, --score           generate score
-  -t, --tidy            check tidy
-  -d, --dir             create dir for individual submission
-  -i, --indv            check individual submission
-  -g, --group           check group submission
-  -j, --joj             check joj score
-  -u, --upload          upload score to canvas
-```
-
-Please modify `JOJ_INFO` for different homework.
+Built on [VG101-Grade-Helper](https://github.com/BoYanZh/VG101-Grade-Helper),
+to defend against VG101-Grade-Helper.
 
-### Example
+VG101-Grade-Helper ("the Helper" hereafter) helps TA's grade students' homework
+submitted on [FOCS Gitea](https://focs.ji.sjtu.edu.cn/git). But the open source
+nature of the Helper indicates that any UMJI student can use it. With its power,
+an hgroup (homework group) may preemptively grade their homework before the TA
+does, and adjust their work accordingly.
 
-#### For homework
+Leningrade assists this process by cutting away TA-specific features (Canvas
+integration for instance), instead presenting the grades to the proletariat
+student.
 
-```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)**
-- [x] 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)**
-- [x] 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)**
-- [x] Using global variable, breaking the rule in code_quality.pdf. **(-0.5 mark)**
+## Installation & Usage
 
-## Tips:
+For C and C++, install [ctags](https://github.com/universal-ctags/ctags) for
+code quality evaluation.
+
+## Helper Checklist
+
+This section is copied from the Helper's README.md, with modifications. It
+enumerates what the Helper will grade your work upon.
+
+- [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 their own schedule. **(-0.5 mark)**
+- [x] A student should provide feedback to at least one teammate for each
+      mandatory exercise. Low quality reviews will be ignored. Each student
+      should receive feedback on their individual submission. e.g. For a group
+      of three: student1 → student2 → student3 → student1. **(-1 mark)**
+- [x] 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)**
+- [x] Using global variables, breaking the rule in `code_quality.pdf`.
+      **(-0.5 mark)**
 
-You need set a default grade for assignments on canvas before running the script, otherwise you can not get their submissions and edit scores.