diff --git a/README.md b/README.md index ead0425..4167473 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ # DedoMouse - DedoMouse let's you control your computer mouse with your hands and a webcam. Therefor, it uses the hand and finger tracking of Google's [MediaPipe](https://google.github.io/mediapipe/solutions/hands). ## Development - -DedoMouse is currently in development (just started). +DedoMouse is not under active development. ### Python Setup - - Clone the repo and navigate to the project folder - Create a virtual environment: `python -m venv env` - Install dependencies: `pip install -r requirements.txt` - Start main.py -## License +### Create Executable +Open a console in the virtual environment, then run + +`pyinstaller main.spec` + +This should create a folder named `dist` with the executable. +## License DedoMouse itself is licensed under [MIT License](https://github.com/achimmihca/DedoMouse/blob/main/LICENSE). However, licenses of the used libraries (see requirements.txt) differ. @@ -35,12 +38,5 @@ For development only: - mypy: [MIT and others](https://github.com/python/mypy/blob/master/LICENSE) - pyinstaller: [Custom GPL](https://github.com/pyinstaller/pyinstaller/blob/develop/COPYING.txt) -## Create Executable -Open a console in the virtual environment, then run - -`pyinstaller main.spec` - -This should create a folder named `dist` with the executable. - ## Trivia 'Dedo' is Spanish and means 'finger'.