agate

commit 548d34d8a8bb52dca099ca4aff48245056139fe0
parent 4ff5352f214cbc336eaac46022a1dce7b9c9c8c3
Author: Johann150 <johann.galle@protonmail.com>
Date:   Fri, 19 Feb 2021 11:09:43 +0100

simplify README structure

The document should be easily convertable to text/gemini format.
Level 4 headings are therefore undesirable.

Diffstat:
M
README.md
 | 
16
+++++++---------

1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -14,23 +14,23 @@ Since Agate by default uses port 1965, you should be able to run other servers (
 
 ## Installation and Setup
 
-### Installation
+1. Get a binary for agate. You can use any of the below ways:
 
-#### Pre-compiled
+### Pre-compiled
 
 Download and unpack the [pre-compiled binary](https://github.com/mbrubeck/agate/releases).
 
-#### NixOS/Nix
+### NixOS/Nix
 
 Using the nix package manager run `nix-env -i agate`
 
 _Note:_ agate is currently only in the unstable channel and will reach a release channel once the next release is tagged
 
-#### Cargo
+### Cargo
 
 If you have the Rust toolchain installed, run `cargo install agate` to install agate from crates.io.
 
-#### Source
+### Source
 
 Download the source code and run `cargo build --release` inside the source repository, then find the binary at `target/release/agate`.
 
@@ -39,16 +39,14 @@ You can use the install script in the `tools` directory for the remaining steps 
 If there is none, please consider contributing one to make it easier for less tech-savvy users!
 ***
 
-### Setup
-
-1. Generate a self-signed TLS certificate and private key.  For example, if you have OpenSSL 1.1 installed, you can use a command like the following.  (Replace the hostname `example.com` with the address of your Gemini server.)
+2. Generate a self-signed TLS certificate and private key.  For example, if you have OpenSSL 1.1 installed, you can use a command like the following.  (Replace the hostname `example.com` with the address of your Gemini server.)
 
 ```
 openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \
     -days 3650 -nodes -subj "/CN=example.com"
 ```
 
-2. Run the server. You can use the following arguments to specify the locations of the content directory, certificate and key files, IP address and port to listen on, host name to expect in request URLs, and default language code(s) to include in the MIME type for for text/gemini files: (Again replace the hostname `example.com` with the address of your Gemini server.)
+3. Run the server. You can use the following arguments to specify the locations of the content directory, certificate and key files, IP address and port to listen on, host name to expect in request URLs, and default language code(s) to include in the MIME type for for text/gemini files: (Again replace the hostname `example.com` with the address of your Gemini server.)
 
 ```
 agate --content path/to/content/ \