diff --git a/quickstart.txt b/quickstart.txt new file mode 100644 index 0000000..7626bea --- /dev/null +++ b/quickstart.txt @@ -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. \ No newline at end of file