Restructure documentation - separate Inspect by hash

docs/CHANGELOG.md

@@ -4,6 +4,8 @@ Blackboard Gradebook Organiser - main (functional) changes and new features log
 
 ## **Notable updates**
 
+2024-04-30 Restructure documentation - separate *Inspect by hash*
+
 2024-03-01 Allow customisation of default settings - most useful default to edit is `IGNORE_DIRS`: the list of names for directories, or files, to ignore when extracting from compressed files
 
 2023-07-17 Documentation updated and web docs added at [docs.vangef.net/BBGradebookOrganiser](https://docs.vangef.net/BBGradebookOrganiser)

docs/README.md

@@ -46,7 +46,7 @@ Optionally, you can inspect the submissions for identical files (by generating a
 
 ## **Instructions**
 
-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).
+See the documentation for [Requirements & Settings](instructions/requirements-settings.md) and [Usage](instructions/usage.md) instructions, and more information & details about [***Inspect by hash***](inspect/about.md).
 
 ## **General notes**
 

docs/inspect/about.md

@@ -26,4 +26,4 @@ With **Inspect by hash** you can inspect the submissions for identical files (by
 
 - File names and paths listed in the generated CSV files have hyperlinks to the actual files for a quick inspection of the file contents (or running the files, if executable)
 
-*Note:* Further analysis needs to be done manually by inspecting and filtering the generated output, depending on the submission and its files.
+*Note:* Further analysis needs to be done manually by inspecting and filtering the generated output, depending on the submission and its files.

docs/inspect/requirements.md

@@ -0,0 +1,9 @@
+# **Inspect by hash** :mag:
+
+## **Requirements**
+
+The ***inspect*** scripts require the `pandas` package - if it's not already installed, run:
+
+```console
+python -m pip install pandas
+```

docs/inspect/usage.md

@@ -1,13 +1,5 @@
 # **Using Inspect by hash** :mag:
 
-## **Requirements**
-
-Before running the *inspect* scripts for the first time, you also need to install the *pandas* package:
-
-```console
-python -m pip install pandas
-```
-
 ## **Inspect gradebook**
 
 If you haven't already, extract the downloaded from *Blackboard* gradebook in a new directory inside *BB_gradebooks*

docs/instructions/requirements-settings.md

@@ -22,7 +22,7 @@ python -m pip install -r requirements.txt
 
 - `brew install rar` for Mac
 
-## (Optional) **Edit defaults**
+## (Optional) **Edit settings**
 
 You can change the default settings by editing *utils/settings.py*. The main setting you might want to edit is `IGNORE_DIRS` - the list of names for directories, or files, to ignore when extracting from compressed files.
 
@@ -34,4 +34,4 @@ Ignored directories by default:
 
 - `node_modules` (npm)
 
-- `vendor` (composer / laravel)
+- `vendor` (composer / laravel)