Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-27 14:30:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
thelounge/README.md
Jérémie Astori 485fab6cd4 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 04:14:17 -05:00

2.6 KiB
Raw Blame History

The Lounge

#thelounge IRC channel on freenode npm version Travis CI Build Status AppVeyor Build Status Dependencies Status Developer Dependencies Status

The Lounge is a modern web IRC client designed for self-hosting.

To learn more about configuration, usage and features of The Lounge, take a look at the website.

The Lounge is the official and community-managed fork of Shout, by Mattias Erming.

Installation and usage

The Lounge requires Node.js v4 or more recent.

Running stable releases from npm (recommended)

Run this in a terminal to install (or upgrade) the latest stable release from npm:

[sudo] npm install -g thelounge

When installation is complete, run:

lounge start

For more information, read the documentation, wiki, or run:

lounge --help

Running from source

The following commands install the development version of The Lounge:

git clone https://github.com/thelounge/lounge.git
cd lounge
npm install
npm start

A word of caution:

  • While it is the most recent codebase, this is not production-ready!
  • It is not recommended to run this as root. However, if you decide to do so, you will have to run npm run build.

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
  • 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