| 1 | ### Kiwi IRC - A hand-crafted IRC client\r |
| 2 | Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.\r |
| 3 | Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.\r |
| 4 | \r |
| 5 | For more information see https://kiwiirc.com or live instance of the application can be found at https://kiwiirc.com/client/.\r |
| 6 | Our development IRC channel is on the Freenode network, irc.freenode.net #kiwiirc.\r |
| 7 | \r |
| 8 | [![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/kiwiirc.png)](https://kiwiirc.com/client/irc.freenode.net/#kiwiirc)\r |
| 9 | \r |
| 10 | \r |
| 11 | ### Installation\r |
| 12 | \r |
| 13 | *Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*\r |
| 14 | \r |
| 15 | 1. Download the Kiwi source or clone the git repository:\r |
| 16 | \r |
| 17 | `$ git clone https://github.com/prawnsalad/KiwiIRC.git && cd KiwiIRC`\r |
| 18 | \r |
| 19 | 2. Install the dependencies:\r |
| 20 | \r |
| 21 | `$ npm install`\r |
| 22 | \r |
| 23 | 3. Copy and edit the configuration file as needed:\r |
| 24 | \r |
| 25 | `$ cp config.example.js config.js`\r |
| 26 | \r |
| 27 | `$ nano config.js`\r |
| 28 | \r |
| 29 | 4. Make sure the client code is built:\r |
| 30 | \r |
| 31 | `$ ./kiwi build`\r |
| 32 | \r |
| 33 | \r |
| 34 | ### Running\r |
| 35 | From the source folder: `$ ./kiwi start`\r |
| 36 | \r |
| 37 | You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`\r |
| 38 | \r |
| 39 | Open your new Kiwi instance in your browser. By default: http://localhost:7778/\r |
| 40 | \r |
| 41 | \r |
| 42 | ### Bugs\r |
| 43 | Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r |
| 44 | \r |
| 45 | ### Licence\r |
| 46 | GNU Affero\r |
| 47 | http://www.gnu.org/licenses/agpl.html\r |
| 48 | \r |
| 49 | \r |
| 50 | ### Thanks to\r |
| 51 | The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r |