Hyper-literate programming is to literate programming exactly what hypertext documents are to regular books and texts.

Go to file

Georges Dupéron 57a4d0184d Closed #2 Wrong order of chunks: all @CHUNKs are inserted first, then the @chunks		2016-09-16 23:06:25 +02:00
lang	Fixes lots of issues. Fixes scribble bug #25 (last commit didn't fix it in the end). Fixes arrows in DrRacket. Fixes some identifier conflicts.	2016-06-23 21:11:17 +02:00
private	Closed #2 Wrong order of chunks: all @CHUNKs are inserted first, then the @chunks	2016-09-16 23:06:25 +02:00
scribblings	Documentation changes suggested by O. Andreescu. Thanks!	2016-08-15 01:24:18 +02:00
test	Closed #2 Wrong order of chunks: all @CHUNKs are inserted first, then the @chunks	2016-09-16 23:06:25 +02:00
.gitignore	Initial commit	2016-06-16 14:21:44 +02:00
.travis.yml	Added Racket 6.6 to Travis build. The scribble-enhanced package was updated for compatibility with Racket < 6.4, so this should fix the previous commit.	2016-09-15 20:28:58 +02:00
info.rkt	Use the enhancements from scribble-enhanced (they might be merged in this repository at one point).	2016-09-15 19:34:15 +02:00
lang.rkt	Added #%top-interaction (not the right one, though)	2016-06-23 21:42:57 +02:00
LICENSE.txt	Initial commit	2016-06-16 14:21:44 +02:00
main.rkt	Bug #1402 on phc-adt/test/test-structure-low-level.rkt 43fd1bad4173baad0ede84e8ed88f917eec7b327	2016-07-29 17:12:57 +02:00
README.md	Added Installation section to README	2016-08-17 15:09:48 +02:00

README.md

hyper-literate

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. repeating the same chunk in several places in the output document, but keeping a single copy in the source code).

Ultimately, the reading experience should be closer to viewing an interactive presentation, focusing 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, but with explanatory text coming along with the source code.
Imagine something like Inform, but focused on exploring a program instead of exploring an imaginary world — after all, a program is some kind of imaginary world.

Installation

Install with:

raco pkg install --deps search-auto hyper-literate