From 5c6e3047012c4aa1eeb6aaab443c31059b12dbfc Mon Sep 17 00:00:00 2001 From: Steve Date: Fri, 21 Feb 2020 16:13:54 -0500 Subject: [PATCH] formatting --- README.md | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index bbd7d1e..79b7d4b 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,42 @@ -SecretShop: a small Gemini server. +# SecretShop: a small Gemini server. -# Features +## Features * Multi-site hosting * Also supports simple Gopher hosting * Fully compliant with Jetforce diagnostics * Probably won't kill your computer -# Configuration +## Configuration SecretShop looks in it's current running directory and /etc/secretshop for it's config file. Configuration is in config/yaml in one of the above directories. See the sample config for more details but a standard file looks like such: ---- -active_capsules: - - localhost -localhost: - Hostname: "localhost" - Port: "1965" - RootDir: "/var/gemini" - CGIDir: "/var/gemini/cgi" - KeyFile: "localhost.key" - CertFile: "localhost.crt" + --- + active_capsules: + - localhost + localhost: + Hostname: "localhost" + Port: "1965" + RootDir: "/var/gemini" + CGIDir: "/var/gemini/cgi" + KeyFile: "localhost.key" + CertFile: "localhost.crt" Please note that CGIDir currently not used (waiting on spec clarification). -# Installation +## Building +Running "make" should work for any given x86 machine. + +If you're planning on running this on a Raspberry Pi or other ARM machine try + env GOOS=linux GOARCH=arm GOARM=5 make + +## Installation Running "make install" will install to /usr/local/bin by default. Running "make service" will install to /usr/local/bin and also install the systemd service file -# Uninstall -Simply run "make uninstall" +## Uninstall +Simply run "make uninstall". -# Running +## Running Either run the executable directly or use the SystemD unit file