Change formatting in commands.js
[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
82e14308 5For more information see http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/\r
b3883e22 6\r
bab469ee 7\r
82e14308 8### Installation\r
b3883e22 9\r
82e14308 101. Download the Kiwi source or clone the git repository:\r
6c3ce7a2 11\r
6b6b967f 12 `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`\r
bab469ee 13\r
82e14308 142. Install the dependancies and make sure the client code is built:\r
c2708b45 15 \r
82e14308
D
16 `$ npm install`\r
17\r
18 `$ node client/assets/dev/build.js`\r
19\r
1f49a029
D
203. Copy and edit the configuration file as needed:\r
21\r
22 `$ cp config.example.js config.js`\r
82e14308
D
23\r
24 `$ nano config.js`\r
25\r
26\r
27### Running\r
28From the source folder: `$ ./kiwi start`\r
29\r
30You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`\r
b3883e22 31\r
6b6b967f
D
32Open your new Kiwi instance in your browser. By default: http://localhost:7778/\r
33\r
c2708b45 34\r
82e14308 35### Bugs\r
c2708b45
JA
36Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
37\r
82e14308 38### Licence\r
85abff7c
D
39GNU Affero\r
40http://www.gnu.org/licenses/agpl.html\r
66fa3842
D
41\r
42\r
82e14308 43### Thanks to\r
6c3ce7a2 44The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r