suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Added README

Browse Source
This commit is contained in:
Georges Dupéron 2016-06-16 15:02:50 +02:00
parent 36faaad4ff
commit 6098afd1bd
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -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.