diff --git a/README.md b/README.md index 11c8495..46adb23 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,16 @@ You can also find support via our IRC channels: `#PyLink @ irc.overdrivenetworks ## Installation +### Pre-requisites +* CPython 3.4 or above (other intepreters are untested and unsupported) +* A Unix-like operating system: PyLink is actively developed on Linux only, so we cannot guarantee that things will work properly on other systems. + +If you are a developer and want to help make PyLink more portable, patches are highly appreciated. Talk to us! + ### Installing from source 1) First, make sure the following dependencies are met: - * Python 3.4+ * Setuptools (`pip3 install setuptools`) * PyYAML (`pip3 install pyyaml`) * ircmatch (`pip3 install ircmatch`) diff --git a/docs/faq.md b/docs/faq.md index 25e404d..f9b159f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -51,7 +51,6 @@ InterJanus-style links between PyLink daemons are not supported yet; see https:/ PyLink provides, in no particular order: - More complete support for modern IRCds (UnrealIRCd 4.x, InspIRCd 2.0, charybdis 4, Nefarious IRCu, etc.). - A flexible, maintainable codebase extensible beyond Relay. -- Cross platform functionality (*nix, Windows, and probably others too). - Proper protocol negotiation leading to fewer SQUIT/DoS possibilities: - Better support for channel modes such as +fjMOR, etc. - Proper support for nick length limits with relayed users.