From 3d9fdc866930a9c03ab6a24bf473471432d2fab9 Mon Sep 17 00:00:00 2001 From: mappu Date: Mon, 31 Dec 2018 18:50:23 +1300 Subject: [PATCH] doc: update README --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a37489..b5a66ca 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,15 @@ A web interface to an NMDC/ADC hub. -Chat in real-time on your NMDC/ADC hub using a web browser. This project forks and deprecates my earlier `dcwebui2` project since Go seems to use less memory than node. +Chat in real-time on your NMDC/ADC hub using a web browser. + +## Relationship to other projects + +This project forks and deprecates my earlier `dcwebui2` project since Go seems to use less memory than node. This project supercedes [dcwebui](https://code.ivysaur.me/dcwebui/), [flexdc](https://code.ivysaur.me/flexdc/), and [dcwebui2](https://code.ivysaur.me/dcwebui2/). -## Upgrading from `dcwebui2` +### Upgrading from `dcwebui2` - The configuration file content is identical between `nmdc-webfrontend` 1.0.0 and `dcwebui2` 1.3.0, but please now ensure it's valid JSON instead of arbitrary javascript. This means no assignment, use double-quoted strings, and no comments. - Future changes to the configuration file since `nmdc-webfrontend` 1.0.0 are backward compatible (see the changelog for more details). @@ -15,9 +19,9 @@ This project supercedes [dcwebui](https://code.ivysaur.me/dcwebui/), [flexdc](ht 1. Install Go (>= 1.11), Node.js, NPM, and 7-Zip (`p7zip-full` on Debian) 2. Download the source code -    - `git clone https://git.ivysaur.me/code.ivysaur.me/nmdc-webfrontend.git `; or -    - `go get code.ivysaur.me/nmdc-webfrontend` ; or -    - download and extract a source archive + - `git clone https://git.ivysaur.me/code.ivysaur.me/nmdc-webfrontend.git `; or + - `go get code.ivysaur.me/nmdc-webfrontend` ; or + - download and extract a source archive 3. Install dependencies: `sudo make deps` 4. Build: `make` 5. Optional: Set `web.external_webroot: true` in the config file for unminified development