new README file.

README.txt

@@ -0,0 +1,146 @@
+Thorsten Jolitz
+
+
+Table of Contents
+_________________
+
+1 outshine.el --- outline with outshine outshines outline
+.. 1.1 Copyright
+.. 1.2 License
+.. 1.3 Credits
+.. 1.4 Commentary
+..... 1.4.1 About outshine
+..... 1.4.2 Installation
+..... 1.4.3 Emacs Version
+.. 1.5 ChangeLog
+
+
+1 outshine.el --- outline with outshine outshines outline
+=========================================================
+
+1.1 Copyright
+~~~~~~~~~~~~~
+
+  Copyright (C) 2013 Thorsten Jolitz
+
+  Authors: Thorsten Jolitz, Carsten Dominik, Per Abrahamsen
+  Maintainer: Thorsten Jolitz <tjolitz AT gmail DOT com>
+  Version: 0.9
+  Keywords:  outlines, file structuring
+
+
+1.2 License
+~~~~~~~~~~~
+
+  This file is not (yet) part of GNU Emacs
+
+  This file is 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 3, or (at your option) any
+  later version.
+
+  This file is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+
+  For a full copy of the GNU General Public License see
+  [http://www.gnu.org/licenses/].
+
+
+1.3 Credits
+~~~~~~~~~~~
+
+  This library is based on, or rather an extension of, Carsten Dominik's
+  `outline-magic' ([https://github.com/tj64/outline-magic]) and my own
+  `outxxtra' ([https://github.com/tj64/outxxtra]), which is itself a
+  modified extension of Per Abrahamsen's `out-xtra.el'
+  ([http://tinyurl.com/aql9p97]). Some ideas were taken from Fabrice
+  Niessen's '`.emacs'
+  ([http://www.mygooglest.com/fni/dot-emacs.html#sec-2]).
+
+
+1.4 Commentary
+~~~~~~~~~~~~~~
+
+1.4.1 About outshine
+--------------------
+
+  This library merges, modifies and extends two existing
+  extension-libraries for `outline' (minor) mode: `outline-magic' and
+  `out-xtra'. It offers all the functionality of `outline-magic' (with
+  some tiny changes) and parts of the functionality of `out-xtra',
+  together with some new features and ideas.
+
+  See `outline-magic.el' ([https://github.com/tj64/outline-magic]) for
+  detailled instructions on usage of the additional outline functions
+  introduced by `outline-magic'.
+
+  Outshines main purpose is to make `outline-minor-mode' more similar to
+  outline-navigation and structure-editing with (the one-and-only)
+  `Org-mode'. Furthermore, as additional but quite useful features,
+  correctly structured outshine-buffers enable the use of `outorg.el'
+  (subtree editing in temporary Org-mode buffers) and `navi-mode.el'
+  (fast navigation and remote-control via modified occur-buffers).
+
+
+1.4.2 Installation
+------------------
+
+  Download `outshine.el' and copy it to a location where Emacs can find
+  it, and use this in your '.emacs' to get started:
+
+  #+begin_src emacs-lisp
+   (require 'outshine)
+   (add-hook  ‘outline-minor-mode-hook ‘outshine-hook-function)
+  #+end_src
+
+  add this for Org-mode style visibility-cycling with TAB and arrow-key
+  navigation:
+
+  #+begin_src emacs-lisp
+     (add-hook ‘outline-minor-mode-hook
+       (lambda ()
+          (define-key outline-minor-mode-map
+            (kbd "<tab>") 'outline-cycle)
+          (define-key outline-minor-mode-map
+            (kbd "<M-left>") 'outline-promote)
+          (define-key outline-minor-mode-map
+            (kbd "<M-right>") 'outline-demote)
+          (define-key outline-minor-mode-map
+            (kbd "<M-up>") 'outline-move-subtree-up)
+          (define-key outline-minor-mode-map
+             (kbd "<M-down>") 'outline-move-subtree-down)))
+  #+end_src
+
+  add this if, e.g., you always want outshine for emacs-lisp buffers:
+
+  f#+begin_src emacs-lisp
+   (add-hook ‘emacs-lisp-mode-hook ‘outline-minor-mode)
+  #+end_src
+
+  If you want a different prefix key for outline-minor-mode, insert
+  first:
+
+  #+begin_src emacs-lisp
+   (defvar outline-minor-mode-prefix "\C-c")
+  #+end_src
+
+  or whatever. The prefix can only be changed before outline (minor)
+  mode is loaded.
+
+
+1.4.3 Emacs Version
+-------------------
+
+  `outshine.el' works with [GNU Emacs 24.2.1 (x86_64-unknown-linux-gnu,
+  GTK+ Version 3.6.4) of 2013-01-20 on eric]. No attempts of testing
+  with older versions or other types of Emacs have been made (yet).
+
+
+1.5 ChangeLog
+~~~~~~~~~~~~~
+
+   date            author(s)          version 
+  -------------------------------------------------
+   2013-03-20 Mi   Thorsten Jolitz      0.9