aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMarkus Uhlin <markus@nifty-networks.net>2023-12-23 02:49:18 +0100
committerMarkus Uhlin <markus@nifty-networks.net>2023-12-23 02:49:18 +0100
commitafd96d5939efc254dec1a64a7f712066f755cb3f (patch)
treeb8426cc93a4e0028703fb52c185fd95e30e19ebd /README.md
parent3cae1efb01857d3d075b1e8305730e3de6bb4aab (diff)
Updated the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 39 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9eaeb32..3a14627 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,50 @@
## About ##
-This is a fork of FICS(Free Internet Chess Server) version 1.6.2 made by Richard Nash.
+This is a fork of FICS(Free Internet Chess Server) version 1.6.2 made
+by Richard Nash.
The fork is maintained by the
[RPBLC computing network](https://www.rpblc.net)
and in particular
[Markus Uhlin](mailto:maxxe@rpblc.net).
-## Cloning ##
+## Installation ##
-To clone the repository use [Git](https://git-scm.com).
+Begin the installation with creating a new user, dedicated for running
+the FICS.
+ # useradd -c "FICS user" -m -p "AccountPassword" chess
+
+When the user has been created login to its account and clone the
+[Git](https://git-scm.com)
+repository:
+
+ $ su -l chess
+ $ mkdir git
+ $ cd git
$ git clone https://github.com/uhlin/fics.git
+ $ cd fics
+
+Edit `FICS/config.h` with a text editor and save the file.
+
+ $ emacs FICS/config.h
+
+From the top-level directory of the cloned Git repository begin the
+building by running make.
+
+ $ make
+
+If the build was successful it's time to install the chess server by
+running `make install`.
+
+ $ make install
+
+Done!
+
+### Make variables ###
+
+If you want you can customize the `FICS_HOME` and `PREFIX` make
+variables found in `options.mk`. But it isn't needed if you've
+followed the installation steps above.
+
+Happy gaming!