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