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

22 lines
640 B
Markdown
Raw Normal View History

2015-03-19 20:55:18 +01:00
# PyLink
<img src="https://dl.dropboxusercontent.com/u/18664770/pylink.png" width="75%" height="75%">
PyLink is an IRC PseudoService written in Python.
2015-03-19 20:55:18 +01:00
## Dependencies
PyLink is a serious WIP right now. Dependencies currently include:
2015-03-19 20:55:18 +01:00
* InspIRCd 2.0.x: more protocol modules may be implemented in the future...
* Python 3.4+
2015-03-19 20:55:18 +01:00
* 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.
2015-03-19 20:55:18 +01:00
2015-04-04 03:47:20 +02:00
2) Run `main.py` from the command line.
2015-03-19 20:55:18 +01:00
3) Profit???