From 17a0f11ffdb77ca5b40d1370426baec0ab9a644d Mon Sep 17 00:00:00 2001 From: Adam Mathes Date: Sat, 7 Jul 2018 09:02:06 -0700 Subject: doc updates --- README.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index af79934..c0e4dd5 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@
-                     ▄▄                 
-                     ██                 
- ██▄████▄   ▄████▄   ██ ▄██▀    ▄████▄  
- ██▀   ██  ██▄▄▄▄██  ██▄██     ██▀  ▀██ 
- ██    ██  ██▀▀▀▀▀▀  ██▀██▄    ██    ██ 
- ██    ██  ▀██▄▄▄▄█  ██  ▀█▄   ▀██▄▄██▀ 
- ▀▀    ▀▀    ▀▀▀▀▀   ▀▀   ▀▀▀    ▀▀▀▀   
-                                        
-                                        
-
-              v0.2 manual
+                     ██
+                     ██
+                     ██
+ ██░████    ░████▒   ██  ▓██▒   ░████░
+ ███████▓  ░██████▒  ██ ▓██▒   ░██████░
+ ███  ▒██  ██▒  ▒██  ██▒██▒    ███  ███
+ ██    ██  ████████  ████▓     ██░  ░██
+ ██    ██  ████████  █████     ██    ██
+ ██    ██  ██        ██░███    ██░  ░██
+ ██    ██  ███░  ▒█  ██  ██▒   ███  ███
+ ██    ██  ░███████  ██  ▒██   ░██████░
+ ██    ██   ░█████▒  ██   ███   ░████░
+
+             v0.2 manual
                7/4/2018
 
+ **Table of Contents** @@ -21,6 +25,7 @@ - [Installation](#installation) - [Requirements](#requirements) - [Building](#building) + - [Dependencies](#dependencies) - [Configuration](#configuration) - [Storage](#storage) - [Usage](#usage) @@ -67,11 +72,19 @@ Backend is written in `Go` and there is a simple javascript frontend and cat ear ## Requirements - * [Go](https://golang.org) - * [SQLite](https://sqlite.org/) - +If you are using a binary, no dependencies! + +NOTE: I haven't put up any binaries yet. + ## Building +### Dependencies + + * [Go](https://golang.org) + * [go-sqlite3](https://github.com/mattn/go-sqlite3) + * [sqlite](https://sqlite.org/index.html) + * [gcc](https://gcc.gnu.org) + $ go get adammathes.com/neko This will download `neko`, dependencies, and build them all in `$GOPATH/src/`. By default this should be something like `$HOME/go/src/`. -- cgit v1.2.3