[KiwiIRC.git] / README.md

# Installation\r
\r
* Download the Kiwi source or clone the git repository:\r
\r
    $ git clone git@github.com:prawnsalad/KiwiIRC.git\r
\r
* Install the dependancies:\r
\r
    $ npm install\r
    \r
* If you're using SSL, create your certificate and key, place it in the server folder.\r
\r
* Edit the configuration file as needed:\r
\r
    $ nano server/config.json\r
    \r
# Running \r
From the source folder:\r
\r
    $ node server/kiwi.js\r
\r
# Bugs\r
Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
\r
# Licence\r
GNU Affero\r
http://www.gnu.org/licenses/agpl.html\r
\r
\r
# Thanks to\r
The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r
Commit	Line	Data
	1	# Installation\r
	2	\r
	3	* Download the Kiwi source or clone the git repository:\r
	4	\r
	5	$ git clone git@github.com:prawnsalad/KiwiIRC.git\r
	6	\r
	7	* Install the dependancies:\r
	8	\r
	9	$ npm install\r
	10	\r
	11	* If you're using SSL, create your certificate and key, place it in the server folder.\r
	12	\r
	13	* Edit the configuration file as needed:\r
	14	\r
	15	$ nano server/config.json\r
	16	\r
	17	# Running \r
	18	From the source folder:\r
	19	\r
	20	$ node server/kiwi.js\r
	21	\r
	22	# Bugs\r
	23	Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues\r
	24	\r
	25	# Licence\r
	26	GNU Affero\r
	27	http://www.gnu.org/licenses/agpl.html\r
	28	\r
	29	\r
	30	# Thanks to\r
	31	The KiwiIRC logo credited to Michael Drahony (www.drahony.com)\r