From 76328b1334e1429e1a2719af2d041ac5fa86dd0e Mon Sep 17 00:00:00 2001 From: Federico Igne Date: Sun, 28 Aug 2022 17:07:34 +0100 Subject: feat(source): provide tangled code alongside the literate program On one hand this defeats the purpose of having the literate program, but it avoids the awkward "bootstrapping" experience. --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index af555c8..69ca732 100644 --- a/README.md +++ b/README.md @@ -124,21 +124,15 @@ if clss.iter().any(|c| c == "override") { ## Tangling: generating the source files -To bootstrap the tangling process, an early version of `pangler` is provided under `bin/` in this repository. +To bootstrap the tangling process, a tangled version of the program is provided alongside the literate version. -You can generate the code for the current version of the program, in the current working directory, with - -```sh -./bin/pangler-v0.1.0 README.md -``` - -and compile it with +The executable can be compiled from the root of the project with ```sh cargo build --release ``` -From now on you can make changes to the `README.md` file and use the latest version of `pangler` to tangle and compile it. +From now on you can make changes to the `README.md` file and use your latest compiled version of `pangler` to tangle and compile it. ## Weaving: generating the documentation @@ -565,12 +559,12 @@ fn write_to_file( # Credits -`pangler v0.2.0` was created by Federico Igne (git@federicoigne.com) and available at [`https://git.dyamon.me/projects/pangler`](https://git.dyamon.me/projects/pangler). +`pangler` was created by Federico Igne (git@federicoigne.com) and available at [`https://git.dyamon.me/projects/pangler`](https://git.dyamon.me/projects/pangler). ```{#Cargo.toml .toml} [package] name = "pangler" -version = "0.2.0" +version = "0.3.0" edition = "2021" [dependencies] -- cgit v1.2.3