Rearrange docs
authorMyhailo Danylenko <isbear@ukrpost.net>
Tue, 21 Aug 2012 02:47:32 +0300
changeset 26 abd0e8810b78
parent 25 21680d75d561
child 27 6de25ac5876c
Rearrange docs
CMakeLists.txt
README
TODO
docs/env.rc
docs/index.mdwn
docs/readme.mdwn
docs/todo.mdwn
env.rc
--- a/CMakeLists.txt	Sun Jul 22 15:29:30 2012 +0300
+++ b/CMakeLists.txt	Tue Aug 21 02:47:32 2012 +0300
@@ -1,7 +1,7 @@
-## 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-env
 #
-# Examples are free software: you can redistribute it and/or modify
+# mcabber-env 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.
@@ -64,7 +64,7 @@
 
 ## Installation
 install(TARGETS env DESTINATION lib/mcabber) 
-install(FILES env.rc COPYING README TODO DESTINATION share/doc/${CPACK_PACKAGE_NAME})
+install(FILES docs/env.rc COPYING docs/readme.mdwn docs/todo.mdwn DESTINATION share/doc/${CPACK_PACKAGE_NAME})
 install(DIRECTORY help DESTINATION share/mcabber)
 install(FILES ${PROJECT_BINARY_DIR}/env.avv DESTINATION share/mcabber/avv/modules RENAME env)
 
--- a/README	Sun Jul 22 15:29:30 2012 +0300
+++ b/README	Tue Aug 21 02:47:32 2012 +0300
@@ -1,45 +1,1 @@
-
-This is a module for mcabber, that allows you to view and
-change mcabber's environment variables and woring directory
-at run-time.
-
-To use this module just load it, commands 'env' and 'cd'
-will be available.
-
-INSTALLATION
-
-To install it, you need:
-make
-cmake
-gcc
-glib
-mcabber's headers
-
-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 libmcabber-env*.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	Sun Jul 22 15:29:30 2012 +0300
+++ b/TODO	Tue Aug 21 02:47:32 2012 +0300
@@ -1,3 +1,1 @@
-
-completion?
-
+docs/todo.mdwn
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/env.rc	Tue Aug 21 02:47:32 2012 +0300
@@ -0,0 +1,3 @@
+
+module load env
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/index.mdwn	Tue Aug 21 02:47:32 2012 +0300
@@ -0,0 +1,9 @@
+
+[[!meta title="mcabber-env"]]
+<a name="mcabber-env"></a>
+# Debugging tools for MCabber
+
+Module allows to examine and change MCabber environment
+variables and current working directory.
+
+[ [[!hg mcabber-env desc="SOURCE"]] ] [ [[README|readme]] ] [ [[TODO|todo]] ] [ [[RC|env.rc]] ]
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Tue Aug 21 02:47:32 2012 +0300
@@ -0,0 +1,50 @@
+
+# MCabber environment investigation
+
+This is a module for mcabber, that allows you to view and change
+mcabber's environment variables and working directory at run-time.
+
+To use this module just load it, the commands 'env' and 'cd' will be
+available.
+
+# Installation
+
+To install it, you need:
+
+ * mcabber headers
+ * glib
+ * 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-env_*.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>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/todo.mdwn	Tue Aug 21 02:47:32 2012 +0300
@@ -0,0 +1,3 @@
+
+* completion?
+
--- a/env.rc	Sun Jul 22 15:29:30 2012 +0300
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,3 +0,0 @@
-
-module load env
-