diff --git a/INSTALL.md b/INSTALL.md index a4c4fff..96cbfd6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -5,13 +5,17 @@ from standard LIBC ones. Care has been taken to use only standard POSIX syscalls so that it should work pretty much on any \*nix system. +Please make sure that you checkout to the correct version you want. +Currently, you most likely want version 3.0. + To compile and install run: ``` $ git clone https://github.com/gophernicus/gophernicus.git $ cd gophernicus +$ git checkout 3.0 $ make -$ sudo make install +# make install ``` That's it - Gophernicus should now be installed, preconfigured @@ -27,10 +31,7 @@ the gopher root and make sure you have at least the primary hostname (the one set with `-h `) directory available (`mkdir /var/gopher/$HOSTNAME`). - -<<<<<<< HEAD:INSTALL -Dependencies -============ +## Dependencies These were obtained from a base docker installation, what we (will) be using on Travis. @@ -66,18 +67,13 @@ These were obtained from a base docker installation, what we # Alpine Linux # - alpine-sdk. once again, less is probably required.. blah blah. -Other installation targets -========================== -======= ## Other installation targets ->>>>>>> 82a1abebc4bfabc43ef6b27f0627f526984eaf30:INSTALL.md Suppose your server runs systemd, but you'd rather have Gophernicus started with inetd or xinetd. To do that, do `make install-inetd` or `make install-xinetd`. Likewise use `make uninstall-inetd` or `make uninstall-xinetd` to uninstall Gophernicus. - ## Compiling with TCP wrappers Gophernicus uses no extra libraries... well... except libwrap @@ -93,7 +89,6 @@ at the files `/etc/hosts.allow` and `/etc/hosts.deny` (because the manual pages suck). Use the daemon name 'gophernicus' to make your access lists. - ## Running with traditional inetd superserver If you want to run Gophernicus under the traditional Unix inetd, the @@ -107,7 +102,6 @@ gopher stream tcp nowait nobody /usr/sbin/gophernicus gophernicus -h so we can include them into the next release. -<<<<<<< HEAD:INSTALL -Supported Platforms -=================== +# Supported Platforms | Platform | Versions | | ------------ | ---------------------------- | @@ -178,5 +166,3 @@ Supported Platforms | Arch Linux | up to date | | Gentoo | up to date | | Alpine Linux | Edge, 3.9 | -======= ->>>>>>> 82a1abebc4bfabc43ef6b27f0627f526984eaf30:INSTALL.md diff --git a/README.md b/README.md index 9caa1d7..1c965d3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # Gophernicus -Version 3.0 +Development! DO NOT USE unless you want fiery dragons! +(you probably want to `git checkout 3.0`) *Copyright (c) 2009-2019 Kim Holviala and others* Gophernicus is a modern full-featured (and hopefully) secure gopher daemon. It is licensed under the BSD license. +(If you are looking for installation documentation, please see INSTALL.md). + ## Support/Contact Developers can be reached at .