From 351bdefb8e26727febf5323401989258a763653c Mon Sep 17 00:00:00 2001 From: Cadence Fish Date: Fri, 14 Feb 2020 22:55:26 +1300 Subject: [PATCH] Revise README installation instructions --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4cdcca5..9abfdc0 100644 --- a/README.md +++ b/README.md @@ -58,17 +58,20 @@ If you only use one computer, you can install Bibliogram on that computer and th ## Installing -You need [node.js](https://nodejs.org/en/) to run Bibliogram. Versions before 12.13.0 are untested. +Quick setup, if you've run webservers before: -1. `$ git clone https://github.com/cloudrac3r/bibliogram` +1. Install [node.js](https://nodejs.org/en/) (^12.13.0 suggested) +1. `$ git clone https://github.com/cloudrac3r/bibliogram` If you are using a fork, be sure to actually install that fork instead! -1. `cd bibliogram` +1. `$ cd bibliogram` 1. `$ npm install --no-optional` (for Tor support, omit `--no-optional`) 1. Edit `/config.js` to suit your server environment 1. `$ npm start` Bibliogram is now running on `0.0.0.0:10407`. +See [Wiki:Installing](https://github.com/cloudrac3r/bibliogram/wiki/Installing) and [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for more details. + ## User-facing endpoints - `/` - homepage