From bade83d6c169f36c3a933c1f22cc5d7ef297f278 Mon Sep 17 00:00:00 2001 From: perro Date: Thu, 9 Mar 2023 13:58:14 -0800 Subject: [PATCH] README changes --- README.md | 14 +++++++++++--- scripts/get_fennel.sh | 2 ++ scripts/make_dist.sh | 2 ++ scripts/test.sh | 2 ++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b016ac1..6810fed 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [Pandoc] is a world famous "swiss-army" document converted. This is because Pandoc is also a document parser. Thanks to this capability, this repo is a [Pandoc filter] written in [Lua] for [literate] and [natural] programming -(LNP), i.e.: ["Programming \[...\] as the process of creating works of -literature"][1]. +(LNP), i.e.: "[Programming \[...\] as the process of creating works of +literature][1]". ## Requirements @@ -32,7 +32,15 @@ Learn how to do LNP [here]. ## Test -Inside this repo, do: +Clone this repo: + + git clone https://git.cuates.net/perro/literate-pandoc.git + +Enter the repo: + + cd literate-pandoc + +Inside, do: sh scripts/test.sh FORMAT1 FORMAT2 diff --git a/scripts/get_fennel.sh b/scripts/get_fennel.sh index a379399..c58347c 100644 --- a/scripts/get_fennel.sh +++ b/scripts/get_fennel.sh @@ -1,3 +1,5 @@ +# Downloads Fennel + # Variables NAME="fennel-1.3.0" ROOT=$(git rev-parse --show-toplevel) diff --git a/scripts/make_dist.sh b/scripts/make_dist.sh index 0e68bda..ac42e38 100644 --- a/scripts/make_dist.sh +++ b/scripts/make_dist.sh @@ -1,3 +1,5 @@ +# Makes distribution release + # Variables NAME="literate.min.lua" ROOT=$(git rev-parse --show-toplevel) diff --git a/scripts/test.sh b/scripts/test.sh index cedafcf..b95f3cc 100644 --- a/scripts/test.sh +++ b/scripts/test.sh @@ -1,3 +1,5 @@ +# Makes tests + # Variables ROOT=$(git rev-parse --show-toplevel) FILTER=$ROOT/src/literate.lua