-# Installation\r
+### Kiwi IRC - A hand-crafted IRC client\r
+Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.\r
+Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.\r
\r
-* Install the dependencies\r
+For more information see http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/\r
\r
- $npm install jade\r
\r
- $npm install node-static\r
+### Installation\r
\r
- $npm install uglify-js\r
+1. Download the Kiwi source or clone the git repository:\r
\r
- $npm install socket.io\r
+ `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`\r
\r
- $npm install socket.io-client\r
+2. Install the dependancies and make sure the client code is built:\r
\r
-* If you're using SSL, create your certificate and key, place it in the node foder.\r
+ `$ npm install`\r
\r
-* Edit the configuration file\r
+ `$ node client/assets/dev/build.js`\r
\r
- $nano server/config.json\r
- \r
-# Running \r
- $node server/kiwi.js\r
+3. Edit the configuration file as needed:\r
\r
-# Bugs\r
-Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
+ `$ nano config.js`\r
+\r
+\r
+### Running\r
+From the source folder: `$ ./kiwi start`\r
\r
-# Licence\r
+You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`\r
+\r
+Open your new Kiwi instance in your browser. By default: http://localhost:7778/\r
+\r
+\r
+### Bugs\r
+Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
\r
-To be decided\r
+### Licence\r
+GNU Affero\r
+http://www.gnu.org/licenses/agpl.html\r
\r
\r
-# Thanks to\r
+### Thanks to\r
The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r
projects / KiwiIRC.git / blobdiff