[elpa] externals/lentic 53283a1fc3 223/333: README update and roadmap added.

[ELPA Syncer]

branch: externals/lentic
commit 53283a1fc30f240e3fb223fed1229c37d344f2d8
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    README update and roadmap added.
---
 README.md   | 28 +++++++++++++++++++---------
 roadmap.org | 15 +++++++++++++++
 2 files changed, 34 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 64a8ac57cb..0086e6409d 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,27 @@
-[![Build 
Status](https://travis-ci.org/phillord/lentic.svg?branch=master)](https://travis-ci.org/phillord/lentic)
-
 Lentic allows two buffers to share the same or similar content but
-otherwise operate independently. This allows multi-modal editing, both with
-identical text, or with related but different text. It's somewhat similar to
-Emacs indirect buffers but more powerful.
-
-While lentic could be used for many purposes, the original motivation is to
-enable a literate programming environment. The lentic documentation is
-self-hosting -- the source code contains all of the documentation. It can be
+otherwise operate independently. This can be used for several different
+purposes. Different buffers can be in the same mode, with different locations
+of point, even different text sizes -- in effect, providing multiple
+persistent views.
+
+It is also possible to have the different lentic buffers in different modes,
+giving a form of multi-modal editing. Switching buffers effectively switches
+modes as well.
+
+While the content of two lentic buffers must be related, it does not need to
+be syntactically identical. This allows it to be used for a form of literate
+programming -- for example, one buffer may contain valid LaTeX source with
+blocks of Lisp, while in the other the LaTeX source is commented out, giving
+an entirely valid Lisp file. The lentic documentation is self-hosting -- the
+source code contains all of the documentation written in Org-mode. It can be
 generated and viewed using the menu items (Edit->Lentic->Read Doc), or it can
 be viewed at
 http://homepages.cs.ncl.ac.uk/phillip.lord/lentic/lenticular.html.
 
+As well as the core library, this package also contains various syntactic
+transformations, and a minor-mode for manipulating lentic buffers from a user
+perspective.
+
 Previously, lentic was known as linked-buffer.
 
 ## Contributions
diff --git a/roadmap.org b/roadmap.org
new file mode 100644
index 0000000000..9e471818ad
--- /dev/null
+++ b/roadmap.org
@@ -0,0 +1,15 @@
+
+* 0.9 indirect-buffer replacement
+
+Lentic can serve as a reasoanble replacements for indirect-buffers now that it
+runs efficiently. For 0.9 there will be a "make-lentic-buffer" function that
+is a direct replacement for "make-indirect-buffer".
+
+* 0.10 Improved el->org, orgel->org
+
+Currently, the orgel->org is not very good, so I want to improve this. In
+particular, I want to support :tags: because lots of people want them. The
+block detection improvement needs changing to support many different source
+blocks types in the same buffer. Finally, the export for orgel->org is not
+ideal. At least it needs to hide "Header" (without having to use :noexport:
+everytime).