From 2fa70d233f165037c763a29733c5885e457226e0 Mon Sep 17 00:00:00 2001 From: Christian Semmler Date: Sun, 26 Nov 2023 14:57:19 +0100 Subject: [PATCH] Update README.md [skip ci] --- tools/README.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/tools/README.md b/tools/README.md index 4c0cbae9..83a8227c 100644 --- a/tools/README.md +++ b/tools/README.md @@ -1,6 +1,6 @@ # LEGO Island Decompilation Tools -These are a set of Python tools for helping with the decomp project +These are a set of Python tools for helping with the decomp project. ## Installing Use pip to install the required packages: @@ -9,19 +9,14 @@ Use pip to install the required packages: pip install -r tools/requirements.txt ``` -## reccmp -This is a script to compare the original EXE or DLL with a recpmpiled EXE or DLL, provided a .PDB file +## Overview -## verexp -This verifies exports by comparing the exports of an original DLL and the recompiled DLL +* `reccmp`: Compares the original EXE or DLL with a recompiled EXE or DLL, provided a PDB file +* `verexp`: Verifies exports by comparing the exports of the original DLL and the recompiled DLL +* `checkorder`: Checks `OFFSET` declarations, ensuring they appear in ascending order within a unit +* `isledecomp`: A library that is used by the above scripts, it has a collection of useful classes and functions -## checkorder -This checks the order of C++ source and header files to make sure the functions are in order - -## isledecomp -This is a library that is used by rhe above scripts. it has a collection of useful classes and functions - -### Testing +## Testing `isledecomp` has a small suite of tests. Install pylint and run it, passing in the directory: ``` @@ -35,16 +30,15 @@ In order to keep the code clean and consistent, we use `pylint` and `black`: ``` pip install black pylint ``` -### To run pylint (ignores build and virtualenv): +### Run pylint (ignores build and virtualenv): ``` pylint tools/ --ignore=build,bin,lib ``` - -### To check code formatting without rewriting files: +### Check code formatting without rewriting files: ``` black --check tools/ ``` -### To apply code formatting: +### Apply code formatting: ``` black tools/ ```