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

22 lines
640 B
Markdown

# 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:
* 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. Not all options are properly implemented yet, and the configuration schema isn't finalized yet.
2) Run `main.py` from the command line.
3) Profit???