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,875 Commits 27 Branches 6 Tags 10 MiB
Racket 100%
20ee397610
Go to file
Georges Dupéron 20ee397610 Speed up --check-pkg-deps
2016-08-30 22:47:57 +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 A few small changes. 2016-08-06 00:04:30 +02:00
scribblings Documentation changes suggested by O. Andreescu. Thanks! 2016-08-15 01:24:18 +02:00
test 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
.gitignore Initial commit 2016-06-16 14:21:44 +02:00
.travis.yml Speed up --check-pkg-deps 2016-08-30 22:47:57 +02:00
info.rkt Fixed missing dependency 2016-08-04 22:39:35 +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

Build Status, Coverage Status, Build Stats, Online Documentation.

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