3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 20:22:45 +01:00

Rename config.yml.example -> example-conf.yml

Easier syntax highlighting with editors this way, since the file extension is now something they recognize. Also, update README and .gitignore accordingly.
This commit is contained in:
James Lu 2016-01-03 20:02:23 -08:00
parent a3a27a9031
commit ba7b6af89b
3 changed files with 4 additions and 1 deletions

3
.gitignore vendored
View File

@ -1,4 +1,7 @@
# Ignore config files except the example ones
*.yml *.yml
!example-*.yml
build/ build/
__pycache__/ __pycache__/
*.py[cod] *.py[cod]

View File

@ -29,7 +29,7 @@ You can also find support via our IRC channel: `#PyLink at irc.overdrivenetworks
## Setup ## Setup
1) Rename `config.yml.example` to `config.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update! 1) Rename `example-conf.yml` to `config.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update!
2) Run `./pylink` from the command line. 2) Run `./pylink` from the command line.