42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
[](https://travis-ci.org/jsmaniac/hyper-literate)
|
|
[](https://coveralls.io/github/jsmaniac/hyper-literate)
|
|
[](http://jsmaniac.github.io/travis-stats/#jsmaniac/hyper-literate)
|
|
[](http://docs.racket-lang.org/hyper-literate/)
|
|
|
|
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](http://www.andrewbragdon.com/codebubbles_site.asp), but with
|
|
explanatory text coming along with the source code.
|
|
|
|
* Imagine something like [Inform](http://inform7.com/), 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
|
|
```
|