Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-15 00:37:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
thelounge/README.md

72 lines
2.7 KiB
Markdown
Raw Normal View History

Update the project name Also remove link to the demo and use HTTPS to the docs
2016-02-10 04:30:05 +00:00
# The Lounge
Update README.md
2014-10-01 19:10:14 +00:00
Reduce badge size in readme
2016-10-16 07:11:52 +00:00
[![#thelounge IRC channel on freenode](https://img.shields.io/badge/freenode-%23thelounge-BA68C8.svg)](https://avatar.playat.ch:1000/)
[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)
[![Travis CI Build Status](https://img.shields.io/travis/thelounge/lounge/master.svg?label=linux+build)](https://travis-ci.org/thelounge/lounge)
[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/astorije/lounge/master.svg?label=windows+build)](https://ci.appveyor.com/project/astorije/lounge/branch/master)
[![Dependencies Status](https://img.shields.io/david/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)
[![Developer Dependencies Status](https://img.shields.io/david/dev/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge?type=dev)
Simplify introduction on README Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.
2016-12-11 09:14:17 +00:00
The Lounge is a modern web IRC client designed for self-hosting.
Update the project name Also remove link to the demo and use HTTPS to the docs
2016-02-10 04:30:05 +00:00
Simplify introduction on README Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.
2016-12-11 09:14:17 +00:00
To learn more about configuration, usage and features of The Lounge, take a look at [the website](https://thelounge.github.io).
Added a section explaining why a fork was created.
2016-02-23 19:01:11 +00:00
Fix wrong order between screenshot and badges on README Branch was not exactly up-to-date with `master` when merged, and badges were moved below the title in #713, so we missed that at review time.
2016-12-09 05:51:22 +00:00
<p align="center">
<img src="https://cloud.githubusercontent.com/assets/5481612/19623041/9bbaec40-9888-11e6-9961-8f3e0493ba30.png" width="550">
</p>
Simplify introduction on README Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description.
2016-12-11 09:14:17 +00:00
The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming).
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
## Installation and usage
Update README.md
2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
The Lounge requires [Node.js](https://nodejs.org/) v4 or more recent.
Document supported node version
2016-04-26 10:51:11 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
### Running stable releases from npm (recommended)
Document supported node version
2016-04-26 10:51:11 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
Run this in a terminal to install (or upgrade) the latest stable release from
[npm](https://www.npmjs.com/):
Update README.md
2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
```sh
[sudo] npm install -g thelounge
```
Update README.md
2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
When installation is complete, run:
Added 'shout config' command
2014-08-19 01:53:17 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
```sh
lounge start
Update README.md
2014-08-17 15:40:28 +00:00
```
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:
```sh
Update the project name Also remove link to the demo and use HTTPS to the docs
2016-02-10 04:30:05 +00:00
lounge --help
Update README.md
2014-08-13 01:27:53 +00:00
```
Update README.md
2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
### Running from source
add development setup instructions, thanks @hennevogel, fix #355
2015-02-06 11:10:11 +00:00
Explain about `lounge` command in dev installations
2017-01-23 04:55:17 +00:00
The following commands install and run the development version of The Lounge:
add development setup instructions, thanks @hennevogel, fix #355
2015-02-06 11:10:11 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
```sh
git clone https://github.com/thelounge/lounge.git
cd lounge
add development setup instructions, thanks @hennevogel, fix #355
2015-02-06 11:10:11 +00:00
npm install
Make and document `npm run build` now a mandatory step of the install/build setup This has several reasons, benefits and consequences: - When running on root (which is not recommended anyway), `npm run build` was already necessary. - This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6. - This allows to create both production and development builds when running from source. - It makes `npm run build` compatible with Windows again for development environments (lost in previous commit). - It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment.
2017-01-07 23:29:56 +00:00
NODE_ENV=production npm run build
fix development setup command, fix #535
2015-11-09 16:11:21 +00:00
npm start
add development setup instructions, thanks @hennevogel, fix #355
2015-02-06 11:10:11 +00:00
```
Explain about `lounge` command in dev installations
2017-01-23 04:55:17 +00:00
When installed like this, npm doesn't create a `lounge` executable. Use `npm start -- <command>` to run subcommands.
Make and document `npm run build` now a mandatory step of the install/build setup This has several reasons, benefits and consequences: - When running on root (which is not recommended anyway), `npm run build` was already necessary. - This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6. - This allows to create both production and development builds when running from source. - It makes `npm run build` compatible with Windows again for development environments (lost in previous commit). - It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment.
2017-01-07 23:29:56 +00:00
⚠️ While it is the most recent codebase, this is not production-ready! Run at
your own risk. It is also not recommended to run this as root.
Warn against running from source as root in README
2016-10-29 00:13:54 +00:00
Add information on running from source and clean up README a bit
2016-09-20 04:06:54 +00:00
## 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`
Reference in a new issue Copy permalink