Convert documentation files to RST syntax.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Mon, 24 Oct 2011 02:46:43 +0300
changeset 749 a8d71dd0fbd5
parent 748 a42f5a803c98
child 750 db9827b0fdf5
Convert documentation files to RST syntax.
INSTALL
INSTALL.rst
README
README.rst
--- a/INSTALL	Mon Oct 24 01:53:01 2011 +0300
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,53 +0,0 @@
--*- mode: outline; coding: utf-8 -*-
-
-Copyright (C) 2008-2010 by Oleksandr Gavenko <gavenkoa@gmail.com>
-
-You can do anything with this file without any warranty.
-
-* Setup on Windows.
-
-** Setup HOME.
-
-Setup HOME environment variable. For example:
-
-  <win-drive-char>:\home
-
-** Setup MANPATH.
-
-To use woman with on Windows set MANPATH like this (note that path in
-Cygwin/MinGW style so you need use cygwin-mount.el):
-
-  MANPATH=:/cygdrive/d/home/usr/share/man:/usr/share/man:/usr/local/share/man
-
-for Cygwin or like this:
-
-  MANPATH=/e/home/usr/share/man:/e/bin/MinGW/man:/e/bin/gnuwin32/man
-
-for MinGW and other case.
-
-To get man paths on Cygwin see <cygwin-root>\usr\share\misc\man.conf.
-
-Also you can set woman-manpath variable.
-
-** Setup INFOPATH.
-
-To browse info file inside Emacs set INFOPATH like this for Cygwin:
-
-  INFOPATH=e:/opt/cygwin/usr/share/info;e:/home/usr/share/info;e:/bin/gnuwin32/info;e:/bin/gnuwin32/share/info:
-
-and like this for MinGW:
-
-  INFOPATH=e:/bin/gnutls/share/info;e:/bin/gnuwin32/info;e:/bin/gnuwin32/share/info;e:/bin/MinGW/info;e:/bin/MinGW/share/info;e:/bin/wget/info:
-
-Note that last colon symbol is essential for include also Emacs info to list.
-
-* GTD (org-mode).
-
-In home dir create .gtd subdir with todo.org file. Put simple content on top
-of them:
-
-  -*- coding: utf-8 -*-
-
-  #+STARTUP: overview
-  #+STARTUP: hidestars
-  #+ARCHIVE: %s_done::
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL.rst	Mon Oct 24 02:46:43 2011 +0300
@@ -0,0 +1,64 @@
+.. -*- coding: utf-8 -*-
+
+=======================================
+ 'dot-emacs' installation instruction.
+=======================================
+.. contents::
+
+Copyright (C) 2008-2011 by Oleksandr Gavenko <gavenkoa@gmail.com>
+
+You can do anything with this file without any warranty.
+
+Setup on Windows.
+=================
+
+Setup HOME.
+-----------
+
+Setup HOME environment variable. For example::
+
+  <win-drive-char>:\home
+
+Setup MANPATH.
+--------------
+
+To use woman with on Windows set MANPATH like this (note that path in
+Cygwin/MinGW style so you need use cygwin-mount.el)::
+
+  MANPATH=:/cygdrive/d/home/usr/share/man:/usr/share/man:/usr/local/share/man
+
+for Cygwin or like this::
+
+  MANPATH=/e/home/usr/share/man:/e/bin/MinGW/man:/e/bin/gnuwin32/man
+
+for MinGW and other case.
+
+To get man paths on Cygwin see <cygwin-root>\usr\share\misc\man.conf.
+
+Also you can set woman-manpath variable.
+
+Setup INFOPATH.
+---------------
+
+To browse info file inside Emacs set INFOPATH like this for Cygwin::
+
+  INFOPATH=e:/opt/cygwin/usr/share/info;e:/home/usr/share/info;e:/bin/gnuwin32/info;e:/bin/gnuwin32/share/info:
+
+and like this for MinGW::
+
+  INFOPATH=e:/bin/gnutls/share/info;e:/bin/gnuwin32/info;e:/bin/gnuwin32/share/info;e:/bin/MinGW/info;e:/bin/MinGW/share/info;e:/bin/wget/info:
+
+Note that last colon symbol is essential for include also Emacs info to list.
+
+GTD (org-mode).
+===============
+
+In home dir create .gtd subdir with todo.org file. Put simple content on top
+of them:
+
+  -*- coding: utf-8 -*-
+
+  #+STARTUP: overview
+  #+STARTUP: hidestars
+  #+ARCHIVE: %s_done::
+
--- a/README	Mon Oct 24 01:53:01 2011 +0300
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,31 +0,0 @@
--*- mode: outline; coding: utf-8 -*-
-
-Copyright (C) 2010 by Oleksandr Gavenko <gavenkoa@gmail.com>
-
-You can do anything with this file without any warranty.
-
-* Config files structure.
-
-Main Emacs config file is '~/.emacs'. I decide don't store beside it all
-customisations. Instead it simply load files in such order:
-
-  '~/.emacs-autogen'
-                It content depend on installation environment. Automatically
-                generated.
-  '~/.emacs-pre'
-                For manually written customisation (usually for updating
-                load-path) which can affect on '.emacs-my'. Will not be
-                overridden on install.
-  '~/.emacs.d/my-lisp/autoload-my.el'
-                For defining autoload function for modes (instead loading all
-                mode files to save startup time). Automatically generated.
-  '~/.emacs-custom.el'
-                For storing customisations by Emacs itself. Some settings from
-                this file can effect on loaded elisp files from .emacs-my.
-                Will not be overridden on install.
-  '~/.emacs-my'
-                Here main customisations placed.
-  '~/.emacs-post'
-                For storing connection settings, passwords and enabling modes
-                added to load-path in ~/.emacs-pre. Will not be overridden on
-                install.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Mon Oct 24 02:46:43 2011 +0300
@@ -0,0 +1,38 @@
+.. -*- coding: utf-8 -*-
+
+=====================
+ 'dot-emacs' README.
+=====================
+.. contents::
+
+Copyright (C) 2010 by Oleksandr Gavenko <gavenkoa@gmail.com>
+
+You can do anything with this file without any warranty.
+
+Config files structure.
+=======================
+
+Main Emacs config file is '~/.emacs'. I decide don't store beside it all
+customisations. Instead it simply load files in such order:
+
+  '~/.emacs-autogen'
+                It content depend on installation environment. Automatically
+                generated.
+  '~/.emacs-pre'
+                For manually written customisation (usually for updating
+                load-path) which can affect on '.emacs-my'. Will not be
+                overridden on install.
+  '~/.emacs.d/my-lisp/autoload-my.el'
+                For defining autoload function for modes (instead loading all
+                mode files to save startup time). Automatically generated.
+  '~/.emacs-custom.el'
+                For storing customisations by Emacs itself. Some settings from
+                this file can effect on loaded elisp files from .emacs-my.
+                Will not be overridden on install.
+  '~/.emacs-my'
+                Here main customisations placed.
+  '~/.emacs-post'
+                For storing connection settings, passwords and enabling modes
+                added to load-path in ~/.emacs-pre. Will not be overridden on
+                install.
+