Compare commits
1 Commits
cc786484d7
...
0.1.1
Author | SHA1 | Date | |
---|---|---|---|
19e552e846 |
23
README.md
23
README.md
@ -29,6 +29,11 @@ The "left" directory contains the left half of the original image, and the "righ
|
||||
|
||||
## Installation
|
||||
|
||||
### For Usage as a Windows Executable
|
||||
You can either download a prebuilt executable from the releases section of the repository, or you can build it yourself the building instructions are further down the `README.md`
|
||||
|
||||
### For Usage as a Python Script
|
||||
|
||||
1. Clone this repository.
|
||||
2. Install the required Python packages using pip:
|
||||
|
||||
@ -72,6 +77,24 @@ python main.py --directory path_to_your_directory
|
||||
|
||||
The script will iterate over all images in the directory, and for each image, it will create two new images in the "left" and "right" directories with the suffixes _left and _right added to the original file name.
|
||||
|
||||
## Build from Source
|
||||
|
||||
### Windows Executable
|
||||
|
||||
1. Clone this repository.
|
||||
2. Navigate into the cloned repository.
|
||||
```sh
|
||||
cd image-splitter
|
||||
```
|
||||
3. Install the required Python packages.
|
||||
```sh
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
4. Build the Executable with PyInstaller
|
||||
```sh
|
||||
pyinstaller --onefile --name image-splitter main.py
|
||||
```
|
||||
|
||||
## License
|
||||
This project is licensed under the terms of the MIT license.
|
||||
|
||||
|
Reference in New Issue
Block a user