From f1c3e376c533c7ea767b7737801faa846fcc57fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Tue, 20 Sep 2016 00:06:54 -0400 Subject: [PATCH] Add information on running from source and clean up README a bit --- README.md | 48 +++++++++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 88d0f6e4..d89d16c8 100644 --- a/README.md +++ b/README.md @@ -34,39 +34,53 @@ This fork aims to be community managed, meaning that the decisions are taken in a collegial fashion, and that a bunch of maintainers should be able to make the review process quicker and more streamlined. -## Install +## Installation and usage -To use The Lounge you must have [Node.js](https://nodejs.org/en/download/) installed. -The oldest Node.js version we support is 4.2.0. +The Lounge requires [Node.js](https://nodejs.org/) v4 or more recent. -If you still use 0.10 or 0.12 we strongly advise you to upgrade before installing The Lounge. -For more information on how to upgrade, read the [documentation](https://nodejs.org/en/download/package-manager/). +### Running stable releases from npm (recommended) -``` -sudo npm install -g thelounge +Run this in a terminal to install (or upgrade) the latest stable release from +[npm](https://www.npmjs.com/): + +```sh +[sudo] npm install -g thelounge ``` -## Usage - -When the install is complete, go ahead and run this in your terminal: +When installation is complete, run: +```sh +lounge start ``` + +For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run: + +```sh lounge --help ``` -For more information, read the [documentation](https://thelounge.github.io/docs/) or [wiki](https://github.com/thelounge/lounge/wiki). +### Running from source -## Development setup +The following commands install the development version of The Lounge. A word of +caution: while it is the most recent codebase, this is not production-ready! -To run the app from source, just clone the code and run this in your terminal: - -``` +```sh +git clone https://github.com/thelounge/lounge.git +cd lounge npm install npm start ``` -You will have to run `npm run build` if you change or add anything in -`client/js/libs` or `client/views`. +## Development setup + +Simply follow the instructions to run The Lounge from source above, on your own +fork. + +Before submitting any change, make sure to: + +- Read the [Contributing instructions](https://github.com/thelounge/lounge/blob/master/CONTRIBUTING.md#contributing) +- Run `npm test` to execute linters and test suite +- Run `npm run build` if you change or add anything in `client/js/libs` or `client/views` ## License