README changes
This commit is contained in:
parent
e87d4b1f43
commit
854687c64a
13
README.md
13
README.md
|
@ -12,19 +12,19 @@ literature"][1].
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
Just download this repo:
|
1. Go to [Releases].
|
||||||
|
2. Download `literate.min.lua`
|
||||||
git clone https://git.cuates.net/perro/literate-pandoc.git
|
3. Done!
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
With Pandoc installed and this repo downloaded, do:
|
With `literate.min.lua` downloaded and Pandoc installed, do:
|
||||||
|
|
||||||
pandoc --lua-filter PATH/TO/literate-pandoc/src/literate.lua -t FORMAT DOC
|
pandoc --lua-filter PATH/TO/literate.min.lua -t FORMAT DOC
|
||||||
|
|
||||||
For example, if `DOC` is `source.md` and the output `FORMAT` is HTML, do:
|
For example, if `DOC` is `source.md` and the output `FORMAT` is HTML, do:
|
||||||
|
|
||||||
pandoc --lua-filter PATH/TO/literate-pandoc/src/literate.lua -t html source.md
|
pandoc --lua-filter PATH/TO/literate.min.lua -t html source.md
|
||||||
|
|
||||||
## Manual
|
## Manual
|
||||||
|
|
||||||
|
@ -66,6 +66,7 @@ Happy hacking :)
|
||||||
[literate]: https://en.wikipedia.org/wiki/Literate_programming
|
[literate]: https://en.wikipedia.org/wiki/Literate_programming
|
||||||
[natural]: https://en.wikipedia.org/wiki/Natural-language_programming
|
[natural]: https://en.wikipedia.org/wiki/Natural-language_programming
|
||||||
[1]: https://web.archive.org/web/20170605163729/http://www.desy.de/user/projects/LitProg/Philosophy.html
|
[1]: https://web.archive.org/web/20170605163729/http://www.desy.de/user/projects/LitProg/Philosophy.html
|
||||||
|
[Releases]: https://git.cuates.net/perro/literate-pandoc/releases
|
||||||
[here]: https://git.cuates.net/perro/literate-pandoc/src/branch/no-masters/man/README.md
|
[here]: https://git.cuates.net/perro/literate-pandoc/src/branch/no-masters/man/README.md
|
||||||
[Fennel]: https://fennel-lang.org
|
[Fennel]: https://fennel-lang.org
|
||||||
[Lisp]: https://en.wikipedia.org/wiki/Lisp_(programming_language)
|
[Lisp]: https://en.wikipedia.org/wiki/Lisp_(programming_language)
|
||||||
|
|
Loading…
Reference in New Issue