supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Add information on running from source and clean up README a bit

Browse Source
This commit is contained in:
Jérémie Astori 2016-09-20 00:06:54 -04:00
parent c090ab065f
commit f1c3e376c5
1 changed files with 31 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -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 in a collegial fashion, and that a bunch of maintainers should be able to make
the review process quicker and more streamlined. 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 Lounge requires [Node.js](https://nodejs.org/) v4 or more recent.
The oldest Node.js version we support is 4.2.0.
If you still use 0.10 or 0.12 we strongly advise you to upgrade before installing The Lounge. ### Running stable releases from npm (recommended)
For more information on how to upgrade, read the [documentation](https://nodejs.org/en/download/package-manager/).
``` Run this in a terminal to install (or upgrade) the latest stable release from
sudo npm install -g thelounge [npm](https://www.npmjs.com/):
```sh
[sudo] npm install -g thelounge
``` ```
## Usage When installation is complete, run:
When the install is complete, go ahead and run this in your terminal:
```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 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 install
npm start npm start
``` ```
You will have to run `npm run build` if you change or add anything in ## Development setup
`client/js/libs` or `client/views`.
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 ## License