vangef/BBGradebookOrganiser
1
1
Fork 0
Code Issues Releases Activity

docs: layout / structure changes

Browse Source
This commit is contained in:
vangef
2024-04-26 21:00:50 +01:00
parent de7dc817aa
commit d3767b54a5
6 changed files with 76 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/README.md
View File

@@ -10,7 +10,7 @@ Blackboard Gradebook Organiser
**Blackboard Gradebook Organiser** is a tool for organising a downloaded gradebook with assignment submissions from [Blackboard Learn ⧉](https://en.wikipedia.org/wiki/Blackboard_Learn).
The submission files are organised per student, by extracting the student number from the submission file names and creating a directory per student. Compressed files are extracted into the student's directory, and any remaining individually submitted files are also moved into the student's directory. Student comments from the submissions are also extracted into a single text file for convenient access and review.
Optionally, you can inspect the submissions for identical files (by generating and comparing SHA256 hashes) and detect if any files have been submitted by multiple students. See [Inspect by hash](inspect.md) for more information.
Optionally, you can inspect the submissions for identical files (by generating and comparing SHA256 hashes) and detect if any files have been submitted by multiple students. See [Inspect by hash](inspect/about.md) for more information.
## **Features**
@@ -38,7 +38,7 @@ Optionally, you can inspect the submissions for identical files (by generating a
- The path of any extracted and organised compressed files will be displayed on the terminal - they need to be extracted manually
- [Inspect by hash](inspect.md) generates and compares SHA256 hashes of all the submitted files, and detects files that are identical and have been submitted by multiple students. Two ways to inspect:
- [Inspect by hash](inspect/about.md) generates and compares SHA256 hashes of all the submitted files, and detects files that are identical and have been submitted by multiple students. Two ways to inspect:
- Inspect gradebook: Before organising a gradebook - for identical files in the files submitted to *Blackboard*
@@ -46,11 +46,7 @@ Optionally, you can inspect the submissions for identical files (by generating a
## **Instructions**
See [***Instructions***](instructions.md) for more information & details.
## **Inspect by hash** :mag:
See [***Inspect by hash***](inspect.md) for more information & details.
See the documentation for [Setup](instructions/setup.md) and [Usage](instructions/usage.md) instructions, and more information & details about [***Inspect by hash***](inspect/about.md).
## **General notes**