Add some documentation in the form of a readme
This commit is contained in:
parent
52fd2a9670
commit
2aa19d5608
27
README.md
Normal file
27
README.md
Normal 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
|
||||||
|
```
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user