From 52678eb15baa04c0f18af6b96a7eeae9ac9fd457 Mon Sep 17 00:00:00 2001 From: Joe Downs Date: Tue, 9 Jul 2019 09:21:06 -0400 Subject: [PATCH 1/4] fix: correct typos in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 11331c9..c96bd9d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Implements a connectomics REST interface that leverages the [neuprint](https://g ## Running - % neuprintHTTP -p |PORTNUM| config.json + % neuPrintHTTP -port |PORTNUM| config.json The config file should contain information on the backend datastore that satisfies the connectomics REST API and the location for a file containing a list of authorized users. To test https locally and generate the necessary certificates, run: From b253f92047f51efbcb52d48ac10fb64c1b75d41f Mon Sep 17 00:00:00 2001 From: Joe Downs Date: Tue, 9 Jul 2019 09:22:13 -0400 Subject: [PATCH 2/4] refactor: move README installation blurbs to same place --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c96bd9d..d924ef3 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ Implements a connectomics REST interface that leverages the [neuprint](https://g % go get github.com/connectome-neuprint/neuPrintHTTP +## Installing without kafka support + +If you are having trouble building the server, because librdkafka is missing and you don't need to send log messages to a kafka server, then try this build. + + % go get -tags nokafka github.com/connectome-neuprint/neuPrintHTTP + ## Running % neuPrintHTTP -port |PORTNUM| config.json @@ -18,8 +24,3 @@ a list of authorized users. To test https locally and generate the necessary ce % go run $GOROOT/src/crypto/tls/generate_cert.go --host localhost -## Installing without kafka support - -If you are having trouble building the server, because librdkafka is missing and you don't need to send log messages to a kafka server, then try this build. - - % go get -tags nokafka github.com/connectome-neuprint/neuPrintHTTP From 6f7672a3a8d1d0767cf7206e6bde6327de89d1bc Mon Sep 17 00:00:00 2001 From: Joe Downs Date: Tue, 9 Jul 2019 09:28:32 -0400 Subject: [PATCH 3/4] doc: add section about installing golang --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d924ef3..81a8d84 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ Implements a connectomics REST interface that leverages the [neuprint](https://github.com/janelia-flyem/neuPrint) data model. +## Dependencies +Since neuPrint is written in [golang](https://golang.org), you will need to [download](https://golang.org/dl) and install golang before you can build and run neuPrintHTTP. The build tools for golang are opinionated about the file structure and location of golang projects, but by default the tools will autogenerate the required folders when you `go get` a project. + ## Installation % go get github.com/connectome-neuprint/neuPrintHTTP From 80ea2534431590d06104771501984ccadf40699a Mon Sep 17 00:00:00 2001 From: Joe Downs Date: Tue, 9 Jul 2019 09:30:40 -0400 Subject: [PATCH 4/4] doc: updating install for consistency --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 81a8d84..6ce6799 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Implements a connectomics REST interface that leverages the [neuprint](https://g ## Dependencies Since neuPrint is written in [golang](https://golang.org), you will need to [download](https://golang.org/dl) and install golang before you can build and run neuPrintHTTP. The build tools for golang are opinionated about the file structure and location of golang projects, but by default the tools will autogenerate the required folders when you `go get` a project. -## Installation +## Installing % go get github.com/connectome-neuprint/neuPrintHTTP