Merge branch 'master' of github.com:prawnsalad/KiwiIRC

[KiwiIRC.git] / README.md

### Kiwi IRC - A hand-crafted IRC client\r
Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.\r
Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.\r
\r
For more information see http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/\r
\r
\r
### Installation\r
\r
1. Download the Kiwi source or clone the git repository:\r
\r
    `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`\r
\r
2. Install the dependancies:\r
\r
    `$ npm install`\r
\r
3. Copy and edit the configuration file as needed:\r
\r
    `$ cp config.example.js config.js`\r
\r
    `$ nano config.js`\r
\r
4.  Make sure the client code is built:\r
\r
    `$ ./kiwi build`\r
\r
\r
### Running\r
From the source folder: `$ ./kiwi start`\r
\r
You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`\r
\r
Open your new Kiwi instance in your browser. By default: http://localhost:7778/\r
\r
\r
### Bugs\r
Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
\r
### Licence\r
GNU Affero\r
http://www.gnu.org/licenses/agpl.html\r
\r
\r
### Thanks to\r
The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r