Add some documentation in the form of a readme

This commit is contained in:
Daniel_I_Am 2021-12-27 12:28:12 +01:00
parent 52fd2a9670
commit 2aa19d5608

27
README.md Normal file
View File

@ -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
```