Permalink
Browse files

Initial rewrite of installation guide.

  • Loading branch information...
1 parent 9318990 commit 16d0eeb425217d9473310844577e764673f9a8ed @SaberUK SaberUK committed May 28, 2012
Showing with 79 additions and 0 deletions.
  1. +19 −0 Installation.md
  2. +39 −0 Installation/Mac-OS-X.md
  3. +21 −0 Installation/Windows.md
View
@@ -0,0 +1,19 @@
+# InspIRCd Wiki » Installation
+
+There are many different methods for installing InspIRCd. You will need to pick the one which fits
+your needs best.
+
+To build from source:
+
+* [Source Installation](https://github.com/inspircd/wiki/blob/master/Installation/Source.md) —
+ a guide to the methods through which you can obtain a copy of the InspIRCd source code and build
+ it on your UNIX-like system.
+
+* [Extra Modules](https://github.com/inspircd/wiki/blob/master/Module-Manager.md) — a guide
+ to adding extra and/or non-standard modules via the module manager.
+
+The following operating systems have prebuilt packages available:
+
+* [Mac OS X](https://github.com/inspircd/wiki/blob/master/Installation/Mac-OS-X.md)
+
+* [Windows](https://github.com/inspircd/wiki/blob/master/Installation/Windows.md)
View
@@ -0,0 +1,39 @@
+# InspIRCd Wiki » Installation » Mac OS X
+
+InspIRCd packages are available in the [Homebrew package manager](http://mxcl.github.com/homebrew/).
+
+## Installation
+
+First, ensure that your copy of Homebrew is up to date by executing the following command:
+
+```sh
+brew update
+```
+
+Once you have done this, subscribe to the `SaberUK/irc` tap using the following command:
+
+```sh
+brew tap SaberUK/irc
+```
+
+Now that your copy of Homebrew knows about the InspIRCd packages, you can install the InspIRCd
+packages using one of the following commands:
+
+```sh
+brew install inspircd12 # InspIRCd 1.2
+brew install inspircd20 # InspIRCd 2.0
+brew install inspircd21 # InspIRCd 2.1
+```
+
+InspIRCd will now be downloaded and installed from source. Once it has finished installing, it will
+be available as a keg-only package in your Homebrew directory. This will usually be located at
+`/usr/local/Cellar/inspircdXX/X.Y.Z/`.
+
+## Notable Limitations
+
+* Extra modules such as SSL are not currently available. If you need these then you may wish to
+ [build from source](https://github.com/inspircd/wiki/blob/master/Installation.md).
+
+## Related Links
+
+* [SaberUK/homebrew-irc on GitHub](https://github.com/SaberUK/homebrew-irc).
View
@@ -0,0 +1,21 @@
+# InspIRCd Wiki » Installation » Windows
+
+InspIRCd packages are available on the [InspIRCd download page](https://github.com/inspircd/inspircd/downloads).
+
+## Installation
+
+First, download the installer from the download page (linked above).
+
+Once you have downloaded the installer, execute it and follow the instructions on screen.
+
+Once it has finished installing, it will be available in `C:\Program Files\InspIRCd` on 32-bit
+Windows and `C:\Program Files (x86)\InspIRCd` on 64-bit Windows.
+
+## Notable Limitations
+
+* The Windows GUI is not yet available on the latest releases.
+* InspIRCd 2.1 beta does not currently build on Windows. See issue #144 for more details.
+
+## Related Links
+
+* [Issue #144 on GitHub](https://github.com/inspircd/inspircd/issues/144).

0 comments on commit 16d0eeb

Please sign in to comment.