Skip to content

Commit

Permalink
Add documentation for prebuilt executables
Browse files Browse the repository at this point in the history
  • Loading branch information
N3rdL0rd committed Jun 6, 2024
1 parent ec09b4d commit 38a4447
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,5 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

test
test
resources
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,25 @@ See [docs/usage.md](docs/usage.md) for detailed usage instructions, and [docs/mo

## Installation

Prebuilt:

1. Download the latest release for your platform from the [releases page](https://github.com/N3rdL0rd/TeaRipper/releases)
2. Unzip the release to a directory of your choice
3. Add it to your PATH if you want to run the tools from anywhere, or leave them running from the directory
4. Run the tools as needed (`teacx`, `tearipper`)

From source:

1. Clone the repository
2. Run `pip install -r requirements.txt` to install the required dependencies
3. Run the tools as needed
3. Run the tools as needed (`python teacx.py`, `python tearipper.py`)

Building executables:

1. Make sure you have `pyinstaller` installed (`pip install pyinstaller`)
2. Run `build.bat` to build the executables
3. The executables will be in the `resources` directory
4. Follow the prebuilt installation instructions from step 3

## License

Expand Down
2 changes: 2 additions & 0 deletions build.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdir resources
pyinstaller --onedir --name teacx --distpath resources teacx.py & pyinstaller --onedir --name tearipper --distpath resources tearipper.py
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
lxml
lxml
pyinstaller

0 comments on commit 38a4447

Please sign in to comment.