Skip to content

Commit c59ee81

Browse files
author
arch
committed
update readme
1 parent 36a8f68 commit c59ee81

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,20 @@ A Python program to quickly create prototype algorithms to partially automate th
66

77
## Documentation
88

9-
- The application documentation is located in `./docs/app/site/` (`index.html`).
10-
- The code documentation is located in `./docs/code/_build/html/` (`index.html`).
9+
The application documentation is located in [`./docs/app/docs/index.md`](https://github.com/michael-mueller-git/Python-Funscript-Editor/blob/main/docs/app/docs/index.md)
1110

1211
## Build
1312

1413
### Windows
1514

16-
Use `pyinstaller` in anaconda environment with all required packages set up:
15+
Use `pyinstaller` in anaconda environment with all packages from `requirements.txt` set up. Then run:
1716

1817
```
1918
pip install pyinstaller
20-
pyinstaller --hidden-import "pynput.keyboard._win32" --hidden-import "pynput.mouse._win32" main.py
19+
build.bat
2120
```
2221

23-
NOTE: don't use `--onefile`, this is way to slow
22+
NOTE: don't use `--onefile` with `pyinstaller`, this is way to slow
2423

2524
### Pip-Package (Recommend for Linux)
2625

@@ -30,7 +29,7 @@ Generate distribution package of this project. These are archives that can be up
3029
make docs package
3130
```
3231

33-
This create the distribution package in `./dist`.
32+
This create the distribution package in `./dist`. Or simply type `make all` to build and install the package.
3433

3534
## TODOs
3635

0 commit comments

Comments
 (0)