https://github.com/vmchale/illiterate
Preprocessor for literate programming
https://github.com/vmchale/illiterate
Last synced: 11 months ago
JSON representation
Preprocessor for literate programming
- Host: GitHub
- URL: https://github.com/vmchale/illiterate
- Owner: vmchale
- License: bsd-3-clause
- Created: 2018-04-05T20:33:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-16T19:55:05.000Z (about 6 years ago)
- Last Synced: 2025-01-08T12:08:05.970Z (about 1 year ago)
- Language: Shell
- Size: 51.8 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# illiterate
[](https://travis-ci.org/vmchale/illiterate)
A language-agnostic preprocessor for literate programming. Supports Bird-style
and TeX-style literate programming.
The secondary goal of this project is to advance the state-of-the art for ATS
programming.
## Installation
### Script
You can install with
```bash
curl https://raw.githubusercontent.com/vmchale/illiterate/master/bash/install.sh | sh -s
```
### Releases
You can find releases for select platforms
[here](https://github.com/vmchale/illiterate/releases).
### Building From Source
You can install `atspkg` and `lit` with the following:
```bash
curl -sSl https://raw.githubusercontent.com/vmchale/atspkg/master/bash/install.sh | bash -s
atspkg remote https://github.com/vmchale/illiterate/archive/master.zip
```
If you want to hack on the source:
```bash
git clone git@github.com:vmchale/illiterate.git
cd illiterate/
atspkg build
```
### Manpages
If you install [pandoc](http://pandoc.org/installing.html), manpages will be
automatically generated when running the above. You can view them with
```bash
man lit
```
## Use
As an example:
```bash
lit literate.lidr > plain.idr
```