Improve installation and documentation (See #64).

Makefile

@@ -12,7 +12,7 @@ PHONEY: run all plugin clean quicklearn
 $(quicklearn_bin):
 	@git clone --recursive https://github.com/hpclab/quickrank.git
 	@cd quickrank && mkdir build_ && cd build_ && cmake .. -DCMAKE_CXX_COMPILER=g++-5 -DCMAKE_BUILD_TYPE=Release && make
-	@mv quickrank quickrank/resources
+	@mv quickrank resources/quickrank
 
 quicklearn: $(quicklearn_bin)
 
@@ -27,6 +27,7 @@ $(plugin_obs): $$(patsubst %plugin.so,%*.go,$$@)
 
 # Running the server may optionally depend on quicklearn.
 run: quicklearn $(SERVER)
+	@mkdir -p plugin_storage
 	@./server
 
 clean:

README.md

@@ -7,20 +7,21 @@ searchrefiner is an interactive interface for visualising and understanding quer
 
 It is currently in development, however please find a demo link [on the project home page](https://ielab.io/searchrefiner).
 
-## Documentation
+## Building
 
-Documentation for authentication, administration, and usage can be found at the project homepage: 
-[ielab.io/searchrefiner](https://ielab.io/searchrefiner)
+searchrefiner is built as a Go application. It needs to be installed slightly differently than most Go applications:
 
-## Building
+ 1. First, clone this repository.
+ 2. Configure the application. The application can then be configured via a `config.json` (a [sample](sample.minimal.config.json) is provided). In this minimal file, everything up to and including `Entrez` needs to be configured. The other options below this key do not need to be configured to run searchrefiner in a minimal setting and they should not be changed unless you know what you are doing. Many of the tools require specific attributes in the configuration. Please get in contact if you are setting up your own instance of searchrefiner to determine how these advances configuration items should be set. 
+ 3. Ensure that `g++-5` and `cmake` are installed on your system.
+ 4. Run `make run`. This will download all of the necessary dependencies and run the application. 
 
-searchrefiner is built as a Go application. It can be installed via:
+At the moment, you still need to make an account to use searchrefiner, even locally. The account that you make is a local account and is not the same as the one you might create on another instance of searchrefiner.
 
-```bash
-go install github.com/ielab/searchrefiner
-```
+## Documentation
 
-The application can then be configured via a `config.json` (a [sample](sample.config.json) is provided). Many of the tools require specific attributes in the configuration. Please get in contact if you are setting up your own instance of searchrefiner to determine how these advances configuration items should be set.
+Documentation for authentication, administration, and usage can be found at the project homepage: 
+[ielab.io/searchrefiner](https://ielab.io/searchrefiner)
 
 ## Citing
 

api.go

@@ -13,7 +13,7 @@ import (
 	"github.com/hscells/transmute/fields"
 	tpipeline "github.com/hscells/transmute/pipeline"
 	"github.com/ielab/toolexchange"
-	"github.com/olivere/elastic"
+	"github.com/olivere/elastic/v7"
 	log "github.com/sirupsen/logrus"
 	"io/ioutil"
 	"math"

go.mod

@@ -0,0 +1,21 @@
+module github.com/ielab/searchrefiner
+
+go 1.13
+
+require (
+	github.com/afjoseph/RAKE.Go v0.0.0-20191109090147-068a9e43b194
+	github.com/boltdb/bolt v1.3.1
+	github.com/gin-contrib/gzip v0.0.3 // indirect
+	github.com/gin-gonic/gin v1.6.3
+	github.com/hscells/cqr v0.0.0-20190116111110-345896d4b48b
+	github.com/hscells/cui2vec v0.0.0-20200214070337-d05e62281087
+	github.com/hscells/groove v0.0.0-20200710052214-8c20ac6a00a1
+	github.com/hscells/guru v0.0.0-20200207042420-2dabeb950d69
+	github.com/hscells/metawrap v0.0.0-20201123064837-00897f27efb5
+	github.com/hscells/quickumlsrest v0.0.0-20190213061558-2265f0340fd2
+	github.com/hscells/transmute v0.0.0-20191226011638-492a895bec30
+	github.com/ielab/toolexchange v0.0.0-20210118233513-e4083499eb9a
+	github.com/olivere/elastic/v7 v7.0.22
+	github.com/sirupsen/logrus v1.7.0
+	github.com/xyproto/permissionbolt v1.2.6
+)