Rearrange docs
authorMyhailo Danylenko <isbear@ukrpost.net>
Mon, 20 Aug 2012 18:21:25 +0300
changeset 19 ff5884d8bbf5
parent 18 aeb36f2945de
child 20 f5318a5fd95f
Rearrange docs
CMakeLists.txt
README
TODO
docs/index.mdwn
docs/readme.mdwn
docs/templatecmd.rc
docs/todo.mdwn
templatecmd.rc
--- a/CMakeLists.txt	Mon Aug 20 18:20:07 2012 +0300
+++ b/CMakeLists.txt	Mon Aug 20 18:21:25 2012 +0300
@@ -1,10 +1,10 @@
-## Copyright 2009 Myhailo Danylenko
-# This file is part of mcabber module writing howto examples.
+## Copyright 2009-2012 Myhailo Danylenko
+# This file is part of mcabber-templatecmd
 #
-# Examples are free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 2 of the License, or
-# (at your option) any later version.
+# mcabber-templatecmd is a free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either version
+# 2 of the License, or (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -64,7 +64,7 @@
 
 ## Installation
 install(TARGETS templatecmd DESTINATION lib/mcabber) 
-install(FILES templatecmd.rc TODO README COPYING DESTINATION share/doc/${CPACK_PACKAGE_NAME})
+install(FILES docs/templatecmd.rc TODO docs/readme.mdwn COPYING DESTINATION share/doc/${CPACK_PACKAGE_NAME})
 install(DIRECTORY help DESTINATION share/mcabber)
 install(FILES ${PROJECT_BINARY_DIR}/templatecmd.avv DESTINATION share/mcabber/avv/modules RENAME templatecmd)
 
--- a/README	Mon Aug 20 18:20:07 2012 +0300
+++ b/README	Mon Aug 20 18:21:25 2012 +0300
@@ -1,40 +1,1 @@
-
-This is a module to allow more flexible aliases with shell-like positional
-variable substitution. Provides command '/templatecmd'.
-
-INSTALLATION
-
-To install it, you need:
-cmake
-gcc
-make
-mcabber headers
-glib
-
-Then do
-$ mkdir build
-$ cd build
-$ cmake ..
-$ make edit_cache
-$ make
-# make install
-
-Debian users can instead of make install do
-$ fakeroot make package
-# dpkg -i libmcbaber-templatecmd*.deb
-
-Users of other distributions can select appropriate package
-generator, using cache editor.
-
-LICENSE
-
-This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
-from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
-
-CONTACTS
-
-I will be happy to get feedback, patches, suggestions, etc.
-You can send me email or contact via jabber <isbear@unixzone.org.ua>.
-
-  -- Myhailo Danylenko <isbear@ukrpost.net>
-
+docs/readme.mdwn
\ No newline at end of file
--- a/TODO	Mon Aug 20 18:20:07 2012 +0300
+++ b/TODO	Mon Aug 20 18:21:25 2012 +0300
@@ -1,4 +1,1 @@
-
-some way to set up commands at startup
-double-free lurks in module uninitialization
-
+docs/todo.mdwn
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/index.mdwn	Mon Aug 20 18:21:25 2012 +0300
@@ -0,0 +1,10 @@
+
+[[!meta title="mcabber-templatecmd"]]
+<a name="mcabber-templatecmd"></a>
+# Aliases on steroids for MCabber
+
+Module provides aliases with shell-like positional
+arguments substitution.
+
+[ [[!hg mcabber-templatecmd desc="SOURCE"]] ] [ [[README|readme]] ] [ [[TODO|todo]] ] [ [[RC|templatecmd.rc]] ]
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Mon Aug 20 18:21:25 2012 +0300
@@ -0,0 +1,95 @@
+
+# Aliases on steroids for MCabber
+
+This module provides more flexible aliases with shell-like positional
+argument substitution. For detailed explanation see help file for
+command 'templatecmd', provided by this module. This command is marked
+as safe for use in your mcabberrc (of course, after you loaded this
+module).
+
+Example:
+
+    module load templatecmd
+    templatecmd cat = say_to -f $1 .
+
+# Installation
+
+To install it, you need:
+
+ * mcabber headers
+ * glib
+ * loudmouth
+ * cmake
+ * make
+ * c compiler (gcc)
+ * linker (binutils)
+
+Then do:
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make edit_cache
+    $ make
+    # make install
+
+Debian users can instead of make install do:
+
+    $ make package
+    # dpkg -i libmcabber-templatecmd_*.deb
+
+Users of other distributions can select appropriate package generator,
+using cache editor.
+
+# License
+
+This code underlies terms of GNU GPL v2 or later. You can find it in
+file COPYING from this distribution or on a GNU web-site
+<http://www.gnu.org/licenses/>.
+
+# Contact
+
+I will be happy to get feedback, patches, suggestions, etc.
+You can send me email or contact via jabber <isbear@unixzone.org.ua>.
+
+  -- Myhailo Danylenko <isbear@ukrpost.net>
+
+This is a module to allow more flexible aliases with shell-like positional
+variable substitution. Provides command '/templatecmd'.
+
+INSTALLATION
+
+To install it, you need:
+cmake
+gcc
+make
+mcabber headers
+glib
+
+Then do
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make edit_cache
+$ make
+# make install
+
+Debian users can instead of make install do
+$ fakeroot make package
+# dpkg -i libmcbaber-templatecmd*.deb
+
+Users of other distributions can select appropriate package
+generator, using cache editor.
+
+LICENSE
+
+This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
+from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
+
+CONTACTS
+
+I will be happy to get feedback, patches, suggestions, etc.
+You can send me email or contact via jabber <isbear@unixzone.org.ua>.
+
+  -- Myhailo Danylenko <isbear@ukrpost.net>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/templatecmd.rc	Mon Aug 20 18:21:25 2012 +0300
@@ -0,0 +1,3 @@
+
+module load templatecmd
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/todo.mdwn	Mon Aug 20 18:21:25 2012 +0300
@@ -0,0 +1,5 @@
+
++ some way to set up commands at startup
+* double-free lurks in module uninitialization
+* use var-parser?
+
--- a/templatecmd.rc	Mon Aug 20 18:20:07 2012 +0300
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,3 +0,0 @@
-
-module load templatecmd
-