From 44394e2f3529b967938c7189ccb77a5f38037c8d Mon Sep 17 00:00:00 2001 From: Bram Matthys Date: Thu, 1 Dec 2022 17:17:11 +0000 Subject: [PATCH] Update README.md Get rid of the basic instructions, as people should really follow the installation guide on the wiki. Too often we see people using these half-instructions (since they are not fully complete) and get themselves into trouble. --- README.md | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 8e505c9ee..1cf217126 100644 --- a/README.md +++ b/README.md @@ -11,55 +11,18 @@ online documentation. ## Versions * UnrealIRCd 6 is the *stable* series since December 2021. All new features go in there. -* UnrealIRCd 5 is the *oldstable* series. It will receive bug fixes until - July 1, 2022 plus another 12 months of security fixes. +* UnrealIRCd 5 is the *oldstable* series. It is End Of Life. Only security bugs will + be fixed until June 30, 2023, after which all support will stop. * For full details of release scheduling and EOL dates, see [UnrealIRCd releases](https://www.unrealircd.org/docs/UnrealIRCd_releases) on the wiki ## How to get started -### Use the wiki! -**IMPORTANT:** We recommend you follow our installation guide on the wiki instead of the -steps in this README. The wiki has more detailed information and is more easy to navigate. +Follow the installation guide on the wiki. See: * [Installing from source for *NIX](https://www.unrealircd.org/docs/Installing_from_source) * [Installating instructions for Windows](https://www.unrealircd.org/docs/Installing_(Windows)) -Please consult the online documentation at https://www.unrealircd.org/docs/ when setting up the IRCd! - -### Step 1: Installation -#### Windows -Simply download the UnrealIRCd Windows version from www.unrealircd.org - -Alternatively you can compile UnrealIRCd for Windows yourself. However this is not straightforward and thus not recommended. - -#### *BSD/Linux/macOS -Do the following steps under a separate account for running UnrealIRCd, -[do NOT compile or run as root](https://www.unrealircd.org/docs/Do_not_run_as_root). - -### Step 1: Compile the IRCd - -* Run `./Config` -* Run `make` -* Run `make install` -* Now change to the directory where you installed UnrealIRCd, e.g. `cd /home/xxxx/unrealircd` - -### Step 2: Configuration -Configuration files are stored in the `conf/` folder by default (eg: `/home/xxxx/unrealircd/conf`) - -#### Create a configuration file -If you are new, then you need to create your own configuration file: -Copy `conf/examples/example.conf` to `conf/` and call it `unrealircd.conf`. -Then open it in an editor and carefully modify it using the documentation and FAQ as a guide (see below). - -### Step 3: Booting - -#### Linux/*BSD/macOS -Run `./unrealircd start` in the directory where you installed UnrealIRCd. - -#### Windows -Start -> All Programs -> UnrealIRCd -> UnrealIRCd - ## Documentation & FAQ -You can find the **documentation** online at: https://www.unrealircd.org/docs/ +You can find all **documentation** online at: https://www.unrealircd.org/docs/ We also have a good **FAQ**: https://www.unrealircd.org/docs/FAQ