From 92c7333228f917641f3043285982aabd97db7fa1 Mon Sep 17 00:00:00 2001 From: Adam Mathes Date: Tue, 24 Jan 2017 19:52:28 -0800 Subject: documentation is hard, again --- README.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e96c423..52288ff 100644 --- a/README.md +++ b/README.md @@ -32,53 +32,45 @@ This is not very easy to use/setup/or anything. Sorry! Consider it WIP. ## Installation -### [Install golang](https://golang.org) +### Prerequesites -Go is great! Yay! +[Install Go -- https:/golang.org](https://golang.org) + +[Install MySQL](https://dev.mysql.com) or [MariaDB](https://mariadb.com) or some other drop-in replacement. + +Postgresql support is left as an exercise for the reader to implement and send a pull request for. ### Set up $GOPATH if one doesn't exist already - ``` $ mkdir $HOME/go $ export GOPATH=$HOME/go - ``` ### Get neko code - ``` $ go get github.com/adammathes/neko - ``` ### Get dependencies - - ``` $ cd $HOME/go/src/github.com/adammathes/neko $ make deps OR $ go get [each dependency listed in the Makefile you ignored] - ``` ### Build - - ``` $ go build cmd/nekoweb $ go build cmd/nekocrawl - ``` This should create "nekoweb" and "nekocrawl" binaries because command line flags are annoying. ### Create MySQL table and user - ``` $ msyqladmin -uroot -p create neko $ mysql -uroot -p neko < init.sql $ echo "probably a good idea to make a limited privilege user" $ mysql -uroot -p neko CREATE USER 'neko'@'localhost' identified by 'password' yourgreatpasswordhere; GRANT ALL PRIVILEGES ON neko.* TO 'neko'@'localhost'; - ``` ### Configuration - copy example configuration and edit as needed -- cgit v1.2.3