-### InspIRCd
+## About
-InspIRCd is an IRC daemon written entirely from scratch, it is one of the
-few IRC daemons to be written in C++ and it was released under the GNU
-General Public License. InspIRCd is the second most used IRC daemon
-according to the ranking on SearchIRC.
+InspIRCd is a modular C++ Internet Relay Chat (IRC) server for UNIX-like and Windows systems.
-The first stable release of InspIRCd was in 2002.
+## Supported Platforms
-### Links
+InspIRCd is supported on on the following platforms:
-Website: http://www.inspircd.org
-GitHub: https://github.com/inspircd/inspircd
\ No newline at end of file
+- Most recent BSD variants using the Clang or GCC compilers and the BSD or GNU toolchains (Make, etc).
+
+- Most recent Linux distributions using the Clang or GCC compilers and the GNU toolchain.
+
+- The most recent three major releases of macOS using the AppleClang, Clang, or GCC (*not* LLVM-GCC) compilers and the BSD or GNU toolchains.
+
+- Windows 7 or newer using the MSVC 11 (Visual Studio 2012) compiler and CMake 2.8 or newer.
+
+Alternate platforms and toolchains may also work but are not officially supported by the InspIRCd team. Generally speaking if you are using a reasonably modern UNIX-like system you should be able to build InspIRCd on it.
+
+If you encounter any bugs then [please file an issue](https://github.com/inspircd/inspircd/issues/new).
+
+## Installation
+
+Most InspIRCd users running a UNIX-like system build from source. A guide about how to do this is available on [the InspIRCd wiki](https://wiki.inspircd.org/Installation_From_Source).
+
+Building from source on Windows is generally not recommended but [a guide is available](https://github.com/inspircd/inspircd/blob/insp20/win/README.txt) if you wish to do this.
+
+If you are running on CentOS 7, Debian 7, or Windows binary packages are available from [the downloads page](https://github.com/inspircd/inspircd/releases/latest).
+
+A [Docker](https://www.docker.com) image is also available. See [the inspircd-docker repository](https://github.com/inspircd/inspircd-docker) for more information.
+
+Some distributions ship an InspIRCd package in their package managers. We generally do not recommend the use of such packages as in the past distributions have made broken modifications to InspIRCd and not kept their packages up to date with essential security updates.
+
+## License
+
+InspIRCd is licensed under [version 2 of the GNU General Public License](https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html).
+
+## External Links
+
+* [Website](https://www.inspircd.org)
+* [Documentation](https://wiki.inspircd.org)
+* [GitHub](https://github.com/inspircd)
+* [Support IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd) — \#inspircd on irc.inspircd.org
+* [Development IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd.dev) — \#inspircd.dev on irc.inspircd.org
projects / user / henk / code / inspircd.git / blobdiff