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

Go to file

Georges Dupéron a110b20df1 Attempt at cross-phase structs, didn't work out well.		2017-01-12 02:27:00 +01:00
comments	Attempt at cross-phase structs, didn't work out well.	2017-01-12 02:27:00 +01:00
lang	Cleaned up hiding/restoring comments, partially typed	2017-01-10 15:54:34 +01:00
private	Bugfix: use (code:comment (unsyntax …)) in @chunk, and (code:comment (UNSYNTAX …)) in @CHUNK	2017-01-07 00:14:56 +01:00
scribblings	Fixed potential conflicts with the injected (require lang).	2016-12-16 16:40:01 +01:00
test	Cleaned up hiding/restoring comments, partially typed	2017-01-10 15:54:34 +01:00
.gitignore	Initial commit	2016-06-16 14:21:44 +02:00
.travis.yml	Don't build on older versions, as we now need a very recent patch	2016-12-16 17:19:57 +01:00
comment-reader.rkt	Cleaned up hiding/restoring comments, partially typed	2017-01-10 15:54:34 +01:00
info.rkt	Support for comments with the new comment-reader	2017-01-06 19:02:30 +01: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	Cleaned up the definition of @chunk and @CHUNK. Fixed issues with subscript numbers on chunks, links, and conflicting tags. Now it's possible to re-print a chunk several times without problem.	2016-09-20 03:12:58 +02:00
README.md	Added Installation section to README	2016-08-17 15:09:48 +02:00
restore-comments.rkt	Cleaned up hiding/restoring comments, partially typed	2017-01-10 15:54:34 +01: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