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