diff --git a/README.md b/README.md index f710751..acf588b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ +> **Note** +> +> This program expects that your Gopher server treats **empty lines** as **information lines**. +> +> It also expects the server to **add the hostname** and the **port** number at the end of links. ### Compiling -This program compiles like any other ordinary Go project, simply **run** `go build .` in the project directory. +You need to have Go toolchain installed: +```shell +# Debian +sudo apt install golang + +# Fedora +sudo dnf install golang +``` + +Then, just **clone the repo** and run **`go build .`** to compile an executable. ### Usage ```shell