Commit | Line | Data |
---|---|---|
82e14308 D |
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 | |
c2708b45 | 4 | \r |
12a6ab4c D |
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 | |
8644f2a9 D |
8 | **Developing? Please use the development branch - not the master branch!**\r |
9 | \r | |
12a6ab4c | 10 | [![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/kiwiirc.png)](https://kiwiirc.com/client/irc.freenode.net/#kiwiirc)\r |
b3883e22 | 11 | \r |
bab469ee | 12 | \r |
82e14308 | 13 | ### Installation\r |
b3883e22 | 14 | \r |
20aad048 D |
15 | *Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*\r |
16 | \r | |
82e14308 | 17 | 1. Download the Kiwi source or clone the git repository:\r |
6c3ce7a2 | 18 | \r |
65827197 | 19 | `$ git clone https://github.com/prawnsalad/KiwiIRC.git && cd KiwiIRC`\r |
bab469ee | 20 | \r |
a5b6b852 | 21 | 2. Install the dependencies:\r |
82e14308 | 22 | \r |
d906a5cb | 23 | `$ npm install`\r |
82e14308 | 24 | \r |
1f49a029 D |
25 | 3. Copy and edit the configuration file as needed:\r |
26 | \r | |
27 | `$ cp config.example.js config.js`\r | |
82e14308 D |
28 | \r |
29 | `$ nano config.js`\r | |
30 | \r | |
d906a5cb D |
31 | 4. Make sure the client code is built:\r |
32 | \r | |
33 | `$ ./kiwi build`\r | |
34 | \r | |
82e14308 D |
35 | \r |
36 | ### Running\r | |
37 | From the source folder: `$ ./kiwi start`\r | |
38 | \r | |
39 | You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`\r | |
b3883e22 | 40 | \r |
6b6b967f D |
41 | Open your new Kiwi instance in your browser. By default: http://localhost:7778/\r |
42 | \r | |
c2708b45 | 43 | \r |
82e14308 | 44 | ### Bugs\r |
c2708b45 JA |
45 | Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r |
46 | \r | |
82e14308 | 47 | ### Licence\r |
85abff7c D |
48 | GNU Affero\r |
49 | http://www.gnu.org/licenses/agpl.html\r | |
66fa3842 D |
50 | \r |
51 | \r | |
82e14308 | 52 | ### Thanks to\r |
6c3ce7a2 | 53 | The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r |