hardlounge/README.md
Jérémie Astori fe6da75854 Remove compiled assets and generate them at prepublish time
- Remove minified libs and compiled templates
- Add a `prepublish` script to build assets, that run on `npm install`
  and right before publishing
  See https://docs.npmjs.com/misc/scripts
- Include these compiled assets to the `.gitignore` file
- Add an empty .npmignore to make sure the compiled assets are not
  ignored when publishing
  https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package
- Update the README to reflect changes in development

Note that the Travis CI configuration does not need any tweaking
because it cleans up all extra and changed files, up to publishing on
npm. That is, right before `prepublish` gets run.
See https://docs.travis-ci.com/user/deployment/npm#Releasing-build-artifacts
2016-02-18 06:01:37 +00:00

56 lines
1.7 KiB
Markdown

![#thelounge IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23thelounge%20on%20freenode-blue.svg)
[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)
[![Build Status](https://travis-ci.org/thelounge/lounge.svg?branch=master)](https://travis-ci.org/thelounge/lounge)
[![Dependency Status](https://david-dm.org/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)
[![devDependency Status](https://david-dm.org/thelounge/lounge/dev-status.svg)](https://david-dm.org/thelounge/lounge#info=devDependencies)
# The Lounge
__What is it?__
The Lounge is a web IRC client that you host on your own server.
*This is the official, community-managed fork of @erming's great initiative, the [Shout](https://github.com/erming/shout) project.*
__What features does it have?__
- Multiple user support
- Stays connected even when you close the browser
- Connect from multiple devices at once
- Responsive layout — works well on your smartphone
- _.. and more!_
## Install
```
sudo npm install -g thelounge
```
## Usage
When the install is complete, go ahead and run this in your terminal:
```
lounge --help
```
For more information, read the [documentation](https://thelounge.github.io/docs/).
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
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.`
## License
Available under the [MIT License](http://mths.be/mit).
Some fonts licensed under [SIL OFL](http://scripts.sil.org/OFL) and the [Apache License](http://www.apache.org/licenses/).