Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dax/jmc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Rousselie <david.rousselie@happycoders.org>2011-10-16 19:33:36 +0400
committerDavid Rousselie <david.rousselie@happycoders.org>2011-10-16 19:33:36 +0400
commit9d88361b02982f74feaf96258f1567397d72bd63 (patch)
treefa9f5f65011e4eaa1f132bc64b03111f0deab676
parent9c0edf274f1180a02092bffc031451dc879b0deb (diff)
update documentation links
-rw-r--r--README49
-rw-r--r--README.md40
2 files changed, 40 insertions, 49 deletions
diff --git a/README b/README
deleted file mode 100644
index 3251238..0000000
--- a/README
+++ /dev/null
@@ -1,49 +0,0 @@
-* Installation
-
-** Debian package
-
-Get JCL and JMC Debian packages from
-http://people.happycoders.org/dax/projects and install them:
-
-$ sudo apt-get install python-pysqlite2 python-pyxmpp python-sqlobject
-$ sudo dpkg -i python-jcl_0.1b1_all.deb python-jmc_0.3b1_all.deb
-
-** EasyInstall
-
-Get EasyInstall then run:
-
-$ easy_install jmc
-
-** Manual installation
-
-Get JCL and JMC sources packages and untar them:
-
-$ tar zxvf jcl-0.1b1.tar.gz
-$ cd jcl-0.1
-$ python setup.py install
-$ cd -
-$ tar zxvf jmc-0.3b1.tar.gz
-$ cd jmc-0.3
-$ python setup.py install
-
-* Configuration
-
-Edit /etc/jabber/jmc.conf jabber section according to your Jabber
-server configuration. For help on other options, see
-https://people.happycoders.org/dax/projects/jmc/wiki/ConfigDoc.
-Additional parameters (for Debian install) can be passed through
-command line options (see
-https://people.happycoders.org/dax/projects/jmc/wiki/CommandLineOpts)
-defined in /etc/default/python-jmc.
-
-* Start/Stop JMC
-
-Debian installation:
-
-$ /etc/init.d/python-jmc start/stop
-
-easyinstall or manual installation (see
-https://people.happycoders.org/dax/projects/jmc/wiki/CommandLineOpts
-for options):
-
-$ /usr/bin/jmc
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3b21303
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# JMC
+
+## JMC installation
+
+### Debian package
+
+Get [JCL](http://github.com/dax/jcl/download) and [JMC](http://github.com/dax/jmc/download) Debian packages and install them:
+
+ sudo apt-get install python-pysqlite2 python-pyxmpp python-sqlobject
+ sudo dpkg -i python-jcl_0.1rc2_all.deb python-jmc_0.3rc2_all.deb
+
+### EasyInstall
+
+Get EasyInstall then run:
+
+ easy_install jmc
+
+### Manual installation
+
+Get [JCL](http://github.com/dax/jcl) and [JMC](http://github.com/dax/jmc) sources from Git:
+
+ python setup.py install
+
+## Configuration
+
+Edit `/etc/jabber/jmc.conf` `jabber` section according to your Jabber
+server configuration. For help on other options, see [Configuration documentation](http://github.com/dax/jmc/wiki/Configuration-file-documentation).
+Additional parameters (for Debian install) can be passed through
+[command line options](http://github.com/dax/jmc/wiki/Command-line-options) defined in /etc/default/python-jmc.
+
+## Start/Stop JMC
+
+Debian installation:
+
+ service python-jmc start/stop
+
+easyinstall or manual installation (see
+[command line options](http://github.com/dax/jmc/wiki/Command-line-options)):
+
+ /usr/bin/jmc --help