isledecomp/isle-portable
1
0
Fork 0
mirror of https://github.com/isledecomp/isle-portable.git synced 2024-11-22 23:48:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md [skip ci]

Browse source
This commit is contained in:
Christian Semmler 2023-11-26 14:57:19 +01:00 committed by GitHub
parent d46f2e094b
commit 2fa70d233f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
tools/README.md
View file

@ -1,6 +1,6 @@
# LEGO Island Decompilation Tools # 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 ## Installing
Use pip to install the required packages: Use pip to install the required packages:
@ -9,19 +9,14 @@ Use pip to install the required packages:
pip install -r tools/requirements.txt pip install -r tools/requirements.txt
``` ```
## reccmp ## Overview
This is a script to compare the original EXE or DLL with a recpmpiled EXE or DLL, provided a .PDB file
## verexp * `reccmp`: Compares the original EXE or DLL with a recompiled EXE or DLL, provided a PDB file
This verifies exports by comparing the exports of an original DLL and the recompiled DLL * `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 ## Testing
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
`isledecomp` has a small suite of tests. Install pylint and run it, passing in the directory: `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 pip install black pylint
``` ```
### To run pylint (ignores build and virtualenv): ### Run pylint (ignores build and virtualenv):
``` ```
pylint tools/ --ignore=build,bin,lib pylint tools/ --ignore=build,bin,lib
``` ```
### Check code formatting without rewriting files:
### To check code formatting without rewriting files:
``` ```
black --check tools/ black --check tools/
``` ```
### To apply code formatting: ### Apply code formatting:
``` ```
black tools/ black tools/
``` ```