holm/StartTree
1
0
Fork 0
forked from extern/StartTree
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README

Browse Source
This commit is contained in:
Paul Houser 2020-08-27 17:54:12 -07:00
parent 14a00433f8
commit 5af56f68ae
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -29,13 +29,13 @@ chmod +x generate.py
./init.sh ./init.sh
./generate.py ./generate.py
``` ```
This will create the directory `~/.config/StartTree` containing the default `config.yaml`, as well as generate the html/css, which you can view by pointing your browser at `$HOME/.cache/StartTree/index.html`. This will create the directory `~/.config/StartTree` containing the default `config.yaml`, install `starttree.py` to your `$PATH`, as well as generate the html/css, which you can view by pointing your browser at `$HOME/.cache/StartTree/index.html`.
## Config ## Config
The config should be placed in `~/.config/StartTree/config.yaml` The config should be placed in `~/.config/StartTree/config.yaml`
## Updating the HTML ## Updating the HTML
To re-generate the html/css after editing the config, navigate to the `StartTree` directory and execute `./generate.py`. To re-generate the html/css after editing the config, execute `starttree.py` from any directory.
# Example Config # Example Config
```yaml ```yaml