3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00

readme update

This commit is contained in:
James Lu 2015-04-03 18:47:20 -07:00
parent b1a989c971
commit 2c73424e86

View File

@ -1,10 +1,10 @@
# PyLink
PyLink is an IRC PseudoService written in Python that might one day be a replacement for the now defunct Janus.
PyLink is an IRC PseudoService written in Python that *might one day* be a replacement for the now defunct Janus.
## Dependencies
PyLink is a serious WIP right now (it doesn't even connect to any servers yet!). Dependencies currently include:
PyLink is a serious WIP right now (it doesn't even understand the concept of users yet). Dependencies currently include:
* Python 3.4
* PyYAML (`pip install pyyaml` or `apt-get install python3-yaml`)
@ -13,6 +13,6 @@ PyLink is a serious WIP right now (it doesn't even connect to any servers yet!).
1) Rename `config.yml.example` to `config.yml` and configure your instance there. Of course, most of the options aren't implemented yet!
2) Run `pylink-main.py` from the command line.
2) Run `main.py` from the command line.
3) Profit???