www

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (1828B)

      1 [![Build Status,](https://img.shields.io/travis/jsmaniac/hyper-literate/main.svg)](https://travis-ci.org/jsmaniac/hyper-literate)
      2 [![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/hyper-literate/main.svg)](https://coveralls.io/github/jsmaniac/hyper-literate)
      3 [![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/hyper-literate)
      4 [![Online Documentation.](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/hyper-literate/)
      5 
      6 hyper-literate
      7 ==============
      8 
      9 Some tools which help build hyper-literate programs.
     10 
     11 Hyper-literate programming is to literate programming exactly what hypertext
     12 documents are to regular books and texts. Literate programming is about
     13 telling other programmers how the program works (instead of just telling the
     14 compiler what it does). Telling this story can be done using non-linear,
     15 hyperlinked documents.
     16 
     17 For now these utilities only help with manipulating LP chunks (e.g. repeating
     18 the same chunk in several places in the output document, but keeping a single
     19 copy in the source code).
     20 
     21 Ultimately, the reading experience should be closer to viewing an interactive
     22 presentation, focusing on the parts of the program that are of interest to
     23 you: expand on-screen the chunks you are curious about, run some tests and see
     24 their result, etc.
     25 
     26 * Imagine something like [code
     27   bubbles](http://www.andrewbragdon.com/codebubbles_site.asp), but with
     28   explanatory text coming along with the source code.
     29   
     30 * Imagine something like [Inform](http://inform7.com/), but focused on
     31   exploring a program instead of exploring an imaginary world — after all, a
     32   program is some kind of imaginary world.
     33 
     34 Installation
     35 ------------
     36 
     37 Install with:
     38 
     39 ```
     40 raco pkg install --deps search-auto hyper-literate
     41 ```