aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4a92f79..676df1a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# README #
+![Coverity Scan Build Status](https://scan.coverity.com/projects/31462/badge.svg)
+
## About ##
This is a fork of FICS(Free Internet Chess Server) version 1.6.2 made
@@ -12,6 +14,18 @@ The main goal of the fork is to modernize the codebase, improve the
security and fix bugs. New features, for example, other chess variants
will be added in a later stage.
+### Public chess server ###
+
+[IRCNow](https://ircnow.org/)
+provides a
+[public chess server](https://wiki.ircnow.org/index.php?n=Chess.Chess)
+for everyone to use!
+
+To connect to the server by using
+[XBoard](https://www.gnu.org/software/xboard/), try:
+
+ $ xboard -ics -icshost rpblc.net
+
### IPv6 ###
IPv6 connections are at the moment not supported.
@@ -37,6 +51,19 @@ repository:
$ git clone https://github.com/uhlin/fics.git
$ cd fics
+### Checkout ###
+
+If you want you can checkout a specific version. For example:
+
+ $ git checkout 1.4.4
+
+(This is a good idea since you most likely don't want to run a
+development version.)
+
+To see all tags, type:
+
+ $ git tag
+
Edit `FICS/config.h` with a text editor and save the file.
$ emacs FICS/config.h
@@ -53,6 +80,10 @@ running `make install`.
Done!
+**NOTE**:
+Running `make install` multiple times is totally fine and does no harm
+when a new version of FICS is available.
+
### Make variables ###
If you want you can customize the `FICS_HOME` and `PREFIX` make