Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DaddyChucky authored Sep 4, 2022
1 parent 298f914 commit 264653b
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
# This project is continued on [GitLab](https://gitlab.com/DaddyChucky/PLAGIARISM-DETECTION)!
# COPYRIGHT
## © 2021-2022; DE LAFONTAINE, Charles.

- Reproduction for commercial use is stricly prohibited and would, therefore, be quite contradictory to this project's sole purpose.
- Free for personal usage.
- Need new functionalities? [Contact me!](https://www.linkedin.com/in/charles-de-lafontaine-2506191b2/)

# PROJECT GOAL
# BRIEF DESCRIPTION
Plagiarism detection between students' copies.

# USAGE

- First start? Launch *jsonizer.py* to help you make **EXOS** and **OUT** directories.
- Then, simply put a **ZIP** or a Project folder inside the **EXOS** directory newly created.
- Define the constants for the files and extra folders to ignore while dezipping in *constants.JSON*.
Expand All @@ -20,46 +11,35 @@ Plagiarism detection between students' copies.
## FILE EXTENT DESCRIPTION

### **EXOS**/*plscOut.JSON*

File containing the weight, parent, name, content, size, last modification, and a list of PLSCs for every file 'compiled' based on your *constants.JSON* settings.

### *constants.JSON*

File containing the name of the folders created, as well as the files to be ignored when *jsonizer.py* is ran.

### *dezipper.py*

Unzips all the zip files contained in **EXOS** to mere folders.

### *plsc.py*

Calculates all the PLSCs of the files defined in **EXOS**/*plscOut.JSON*, and not present in ignores of *constants.JSON*.

### *jsonizer.py*

Creates **EXOS** and **OUT** folders (if not already created), then runs *plsc.py*

### *loadcsts.py*

Loads constants of *constants.JSON*. Imported in practically every project file but useless to run individually.

### *oneliner.py*

Runs the whole program in simply one execution. Risky, because you have to know its execution well.

### *comparer.py*

Once PLSCs are done calculating, this file is ran to adjust the final weight and parent of every file.

### *updater.py*

Normalizes every weight of every file by substracting the minimum weight.

### *revealcheats.py*

Reads *plscOut.JSON* and reveals potential cheaters.

# Version log / TODO

- 1.0, working great on Windows. Although, eats too much time for 100+ copies (hours). Need to refine that work.
- Better, refined *updater.py*

0 comments on commit 264653b

Please sign in to comment.