From afd96d5939efc254dec1a64a7f712066f755cb3f Mon Sep 17 00:00:00 2001 From: Markus Uhlin Date: Sat, 23 Dec 2023 02:49:18 +0100 Subject: Updated the readme --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file 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! -- cgit v1.2.3