diff --git a/README.md b/README.md new file mode 100644 index 0000000..6495424 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Daniel's dotfile generator + +## Installing +Enter a python venv +```sh +python -m venv env +source env/bin/activate +``` + +Install dependencies +``` +pip install -r requirements.txt +``` + +Setup local variables +``` +cp local.env.example local.env +``` + +Please edit `local.env` to your liking. + +## Running/Generating dotfiles +Run `run.py` from the python venv +``` +./run.py +``` +