1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-01-05 16:10:31 +02:00

Add README for exerciser.

This commit is contained in:
Andrew Walbran 2023-04-03 14:39:17 +01:00
parent 9375126b3c
commit 04c36de355

19
exerciser/README.md Normal file
View File

@ -0,0 +1,19 @@
# exerciser
This is a tool to generate templates for exercises from the Markdown source. Given a Markdown file
with one or more sections like:
````markdown
<!-- File src/main.rs -->
```rust,compile_fail
{{#include example/src/main.rs:main}}
fn some_more_code() {
// TODO: Write some Rust code here.
}
```
````
You can run it like `cargo run my/markdown/file.md exercise-templates/example`, and it will create a
file `exercise-templates/example/src/main.rs` with the appropriate contents.