suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
Hyper-literate programming is to literate programming exactly what hypertext documents are to regular books and texts.
1,838 Commits 27 Branches 6 Tags 10 MiB
Racket 100%
b895378a51
Go to file
Georges Dupéron b895378a51 Improved README
2016-06-16 16:28:33 +02:00
scribblings Initial commit 2016-06-16 14:21:44 +02:00
typed Pulled out scribble-lib/scribble/lp/lang/common.rkt and scribble-lib/scribble/lp/lang/lang2.rkt and scribble-lib/scribble/lp/lang/reader.rkt and scribble-lib/scribble/private/lp.rkt. 2016-06-16 16:27:55 +02:00
.gitignore Pulled out scribble-lib/scribble/lp/lang/common.rkt and scribble-lib/scribble/lp/lang/lang2.rkt and scribble-lib/scribble/lp/lang/reader.rkt and scribble-lib/scribble/private/lp.rkt. 2016-06-16 16:27:55 +02:00
.travis.yml Initial commit 2016-06-16 14:21:44 +02:00
info.rkt Initial commit 2016-06-16 14:21:44 +02:00
LICENSE.txt Initial commit 2016-06-16 14:21:44 +02:00
main.rkt Added a couple of utilities: defck and repeat-chunk 2016-06-16 14:24:17 +02:00
README.md Improved README 2016-06-16 16:28:33 +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. 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, but with explanative text comming along with the source code.

  • Imagine something like Inform, but focussed on exploring a program instead of exploring an imaginary world — after all, a program is some kind of imaginary world.