From 0556358529a3317dd3b1d4712d2bbdb7ac73f8aa Mon Sep 17 00:00:00 2001 From: mappu Date: Mon, 31 Dec 2018 18:33:13 +1300 Subject: [PATCH] doc: top-level README.md --- _dist/README.txt => README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) rename _dist/README.txt => README.md (82%) diff --git a/_dist/README.txt b/README.md similarity index 82% rename from _dist/README.txt rename to README.md index 59f40ec..4a37489 100644 --- a/_dist/README.txt +++ b/README.md @@ -1,33 +1,28 @@ +# nmdc-webfrontend + 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. -Written in Golang +This project supercedes [dcwebui](https://code.ivysaur.me/dcwebui/), [flexdc](https://code.ivysaur.me/flexdc/), and [dcwebui2](https://code.ivysaur.me/dcwebui2/). -Tags: nmdc +## Upgrading from `dcwebui2` -This project supercedes [entry=dcwebui]dcwebui[/entry], [entry=flexdc]flexdc[/entry], and [entry=dcwebui2]dcwebui2[/entry]. +- 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). -=UPGRADING FROM DCWEBUI2= +## Developing -- 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). - -=DEVELOPING= - -[go-get]code.ivysaur.me/nmdc-webfrontend git https://git.ivysaur.me/code.ivysaur.me/nmdc-webfrontend.git[/go-get] - -1. Install Go, Node.js, NPM, and 7-Zip (`p7zip-full` on Debian) -2. Set up your `$GOPATH` -3. Download the source code +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 -4. Install dependencies: `sudo make deps` -5. Build: `make` -6. Optional: Set `web.external_webroot: true` in the config file for unminified development +3. Install dependencies: `sudo make deps` +4. Build: `make` +5. Optional: Set `web.external_webroot: true` in the config file for unminified development -=CHANGELOG= +## Changelog 2017-11-26 1.3.0 - Update libnmdc to 0.16 (adds ADC hub support)