Updated README.md

Just improved some documentation (as well as wiki) and removed redundant images, reordered requirements.txt
DefinetlyNotAI · Nov 21, 2024 · efea971 · efea971
1 parent 4069bad
commit efea971
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 16 deletions.
diff --git a/IMG/3dir.png b/IMG/3dir.png
diff --git a/IMG/EXE.ico b/IMG/EXE.ico
diff --git a/IMG/ExtraTools.png b/IMG/ExtraTools.png
diff --git a/IMG/Flag Options.png b/IMG/Flag Options.png
diff --git a/IMG/NeedAdmin.png b/IMG/NeedAdmin.png
diff --git a/README.md b/README.md
@@ -40,8 +40,6 @@ To install and setup Logicytics, follow these steps:
 
 - **Dependencies**: The project requires certain Python modules to be installed. You can install all the required modules by running the following command in your terminal: `pip install -r requirements.txt`.
 
-![Admin Error](IMG/NeedAdmin.png "Not using admin will result in a soft crash")
-
 - **Administrative Privileges**: To be able to run the program using certain features of the project, like registry modification, you must run the program with administrative privileges.
 
 - **System Requirements**: The project has been tested on Windows 10 and 11. It will not work on other operating systems.
@@ -94,13 +92,11 @@ If you have an idea or want to contribute to the project, you can submit an issu
 
 ### Basic Usage
 
-![The flag options](IMG/Flag%20Options.png "Here are the options Logicytics has")
-
 After running and successfully collecting data, you may traverse the ACCESS directory as much as you like,
-Remove add and delete files, it's the safest directory where your backups, hashes, data zips and logs are found.
+Remove add and delete files, it's the safe directory where your backups, hashes, data zips and logs are found.
 
 > [!TIP]
-> Watch this [video](https://www.youtube.com/watch?v=XVTBmdTQqOs) to see a real life demo of Logicytics (Although the tools and interface may be changed as its a older version)
+> Watch this [video](https://www.youtube.com/watch?v=XVTBmdTQqOs) to see a real life demo of Logicytics (Although the tools and interface may be changed as it's an older version)
 
 ## 🔧 Configuration 🔧
 
@@ -120,14 +116,13 @@ The config.json file is a JSON file that contains the following information:
 
 The config.json file is used to store the DEBUG flag bool, the VERSION, and the CURRENT_FILES.
 
-CURRENT_FILES is an array of strings that contains the names of the files you have, 
-this is used to later check for corruption or bugs.
-VERSION is the version of the project, used to check and pull for updates.
+> [!TIP]
+> CURRENT_FILES is an array of strings that contains the names of the files you have, 
+> this is used to later check for corruption or bugs.
+> VERSION is the version of the project, used to check and pull for updates.
 
 ## 🚀 Advanced Usage 🚀
 
-![Main 3 Directories](IMG/3dir.png "The 3 Main Directories")
-
 ### Mods
 
 Mods are special files that are run with the `--modded` flag.
@@ -228,10 +223,8 @@ Check out the [contributing guidlines](CONTRIBUTING.md) file for more info
 If there is a specific piece of data that you would like to see extracted by Logicytics,
 please let us know. We are constantly working to improve the project and adding new features.
 
-![Extra Tools](IMG/ExtraTools.png "Here is the inbuilt extra tools menu {BETA}")
-
-Other than mods, some prefixed tools are in the `EXTRA` directory, use the `--extra` flag to traverse these
-special tools
+Other than mods, some prefixed tools are in the `EXTRA` directory, 
+use the `--extra` flag to traverse these special tools
 
 ### Want to create your own mod?
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 requests~=2.32.3
 psutil~=6.1.0
-DateTime~=5.5
 colorlog~=6.9.0
+DateTime~=5.5
 pathlib~=1.0.1