From 6098afd1bde7f1253183206a61c977438f497054 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georges=20Dup=C3=A9ron?= Date: Thu, 16 Jun 2016 15:02:50 +0200 Subject: [PATCH] Added README --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f2d7a59..3feaf161 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ hyper-literate ============== -README text here. + +Some tools which help build hyper-literate programs. + +Hyper-literate programming is to literate programming exactly what hypertext +documents are to regular books and texts. Literate programming is about +telling other programmers how the program works (instead of just telling the +compiler what it does). Telling this story can be done using non-linear, +hyperlinked documents. + +For now these utilities only help with manipulating LP chunks (e.g. repating +the same chunk in several places in the output document, but keep a single +copy in the source code). + +Ultimately, the reading experience should be closer to viewing an interactive +presentation, focussing on the parts of the program that are of interest to +you: expand on-screen the chunks you are curious about, run some tests and see +their result, etc. + +* Imagine something like [code + bubbles](http://www.andrewbragdon.com/codebubbles_site.asp), but with + explanative text comming along with the source code. + +* Imagine something like [Inform](http://inform7.com/), but focussed on + explaining a program. \ No newline at end of file