GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-27 13:09:23 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md, with artwork from @Erenzie

Browse Source
This commit is contained in:
James Lu 2015-06-06 14:23:20 -07:00
parent 0ed1e13115
commit a0babeddcd
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,17 +1,20 @@
# PyLink
<img src="https://dl.dropboxusercontent.com/u/18664770/pylink.png" width="75%" height="75%">
PyLink is an IRC PseudoService written in Python.
## Dependencies
PyLink is a serious WIP right now. Dependencies currently include:
* Python 3.4
* InspIRCd 2.0.x: more protocol modules may be implemented in the future...
* Python 3.4+
* PyYAML (`pip install pyyaml` or `apt-get install python3-yaml`)
## Usage
1) Rename `config.yml.example` to `config.yml` and configure your instance there. Of course, most of the options aren't implemented yet!
1) Rename `config.yml.example` to `config.yml` and configure your instance there. Not all options are properly implemented yet, and the configuration schema isn't finalized yet.
2) Run `main.py` from the command line.