Nickiel/WGU-Capstone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

added quickstart guide

Browse source
This commit is contained in:
Nickiel12 2023-10-03 20:48:45 -07:00
parent fd16db29c8
commit 3b602fdfd5
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
quickstart.txt Normal file
View file

@ -0,0 +1,16 @@
NixOS/Nix:
If you run on a Nix or NixOS environment, you can use the included shell.nix file to create a nix shell to run this in.
Windows/Other Linux:
This program was developed with python 3.11, so please use that version of python to create the virtual environment. After making sure you are using the correct python version, run the following commands:
python -m venv venv
to create a new virtual environment ".\venv"
now enter the the virtual environment by running either .\venv\Scripts\Activate.ps1 or ./venv/Scripts/activate depending on if you use windows and install the following packages (found in requirements.txt)
pip install numpy
pip install opencv-python
Now you can run the program. It is recommended to run the program with -d and -o set while testing. This enables the dashboard which shows live statistics, and output, which shows the calculated adjustments required to center the face in the frame.