README.md

   1 ## About
   2
   3 InspIRCd is a modular C++ Internet Relay Chat (IRC) server for UNIX-like and Windows systems.
   4
   5 ## Supported Platforms
   6
   7 InspIRCd is supported on on the following platforms:
   8
   9 - Most recent BSD variants using the Clang or GCC compilers and the GNU toolchains (Make, etc).
  10
  11 - Most recent Linux distributions using the Clang or GCC compilers and the GNU toolchain.
  12
  13 - The most recent three major releases of macOS using the AppleClang, Clang, or GCC (*not* LLVM-GCC) compilers and the GNU toolchains.
  14
  15 - Windows 7 or newer using the MSVC 14 (Visual Studio 2015) compiler and CMake 2.8 or newer.
  16
  17 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.
  18
  19 If you encounter any bugs then [please file an issue](https://github.com/inspircd/inspircd/issues/new).
  20
  21 ## Installation
  22
  23 **The `master` branch contains the latest development version. If you are running a server then you probably want the `insp20` branch. You can obtain this from [the releases page](https://github.com/inspircd/inspircd/releases) or by running `git checkout $(git describe --abbrev=0 --tags insp20)` if you are installing via Git.**
  24
  25 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).
  26
  27 Building from source on Windows is generally not recommended but [a guide is available](https://github.com/inspircd/inspircd/blob/master/win/README.txt) if you wish to do this.
  28
  29 <!--
  30 TODO: uncomment this once we have binary packages for v3.
  31
  32 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).
  33
  34 A [Docker](https://www.docker.com) image is also available. See [the inspircd-docker repository](https://github.com/inspircd/inspircd-docker) for more information.
  35 -->
  36
  37 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.
  38
  39 ## License
  40
  41 InspIRCd is licensed under [version 2 of the GNU General Public License](https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html).
  42
  43 ## External Links
  44
  45 * [Website](https://www.inspircd.org)
  46 * [Documentation](https://wiki.inspircd.org)
  47 * [GitHub](https://github.com/inspircd)
  48 * [Support IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd) &mdash; \#inspircd on irc.inspircd.org
  49 * [Development IRC channel](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd.dev) &mdash; \#inspircd.dev on irc.inspircd.org