README.md

   1 ### Kiwi IRC - A hand-crafted IRC client
   2 Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.
   3 Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.
   4
   5 For more information see http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/
   6
   7
   8 ### Installation
   9
  10 1. Download the Kiwi source or clone the git repository:
  11
  12     `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`
  13
  14 2. Install the dependancies and make sure the client code is built:
  15
  16     `$ npm install`
  17
  18     `$ node client/assets/dev/build.js`
  19
  20 3. Edit the configuration file as needed:
  21
  22     `$ nano config.js`
  23
  24
  25 ### Running
  26 From the source folder: `$ ./kiwi start`
  27
  28 You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`
  29
  30 Open your new Kiwi instance in your browser. By default: http://localhost:7778/
  31
  32
  33 ### Bugs
  34 Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
  35
  36 ### Licence
  37 GNU Affero
  38 http://www.gnu.org/licenses/agpl.html
  39
  40
  41 ### Thanks to
  42 The KiwiIRC logo credited to Michael Drahony (www.drahony.com)