aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 5 insertions, 11 deletions
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") {
124 124
125## Tangling: generating the source files 125## Tangling: generating the source files
126 126
127To bootstrap the tangling process, an early version of `pangler` is provided under `bin/` in this repository. 127To bootstrap the tangling process, a tangled version of the program is provided alongside the literate version.
128 128
129You can generate the code for the current version of the program, in the current working directory, with 129The executable can be compiled from the root of the project with
130
131```sh
132./bin/pangler-v0.1.0 README.md
133```
134
135and compile it with
136 130
137```sh 131```sh
138cargo build --release 132cargo build --release
139``` 133```
140 134
141From now on you can make changes to the `README.md` file and use the latest version of `pangler` to tangle and compile it. 135From now on you can make changes to the `README.md` file and use your latest compiled version of `pangler` to tangle and compile it.
142 136
143## Weaving: generating the documentation 137## Weaving: generating the documentation
144 138
@@ -565,12 +559,12 @@ fn write_to_file(
565 559
566# Credits 560# Credits
567 561
568`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). 562`pangler` was created by Federico Igne (git@federicoigne.com) and available at [`https://git.dyamon.me/projects/pangler`](https://git.dyamon.me/projects/pangler).
569 563
570```{#Cargo.toml .toml} 564```{#Cargo.toml .toml}
571[package] 565[package]
572name = "pangler" 566name = "pangler"
573version = "0.2.0" 567version = "0.3.0"
574edition = "2021" 568edition = "2021"
575 569
576[dependencies] 570[dependencies]