From 1b859859a6125edf87edbabc22a1afa19cee82de Mon Sep 17 00:00:00 2001 From: Luke Date: Sat, 13 Jul 2024 16:12:27 -0400 Subject: [PATCH] docs(readme): add manual install/setup instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 796aff69..f20e0881 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,22 @@ $ sudo docker run -d -p 80:9000 spacebinorg/spirit #### Manually -WIP +> [!IMPORTANT] +> **Requires: [Git](https://git-scm.com/downloads), [Go 1.22.4](https://go.dev/doc/install), [GNU Makefile](https://www.gnu.org/software/make/#download), and a [PostgreSQL](https://www.postgresql.org/download/) [server](https://m.do.co/c/beaf675c3e00).** + +```sh +# Clone the Github repository +$ git clone https://github.com/lukewhrit/spacebin.git +$ cd spacebin + +# Build the binary +$ make spirit + +# Start Spacebin +$ SPIRIT_CONNECTION_URI="" ./bin/spirit + +# Success! Spacebin is now available at port 9000 on your machine. +``` #### Environment Variables