Skip to content

Commit b326069

Browse files
committed
Add temporary documentation for make.jl
1 parent 01707bc commit b326069

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,33 @@
66

77
Exercism exercises in Julia.
88

9+
## v3: Track-specific tooling
10+
11+
### `make.jl`
12+
13+
Some files, like `.meta/config.json` contain redundant information for the Julia track.
14+
Instead of manually updating these, `.meta/config.toml` and `make.jl` should be used.
15+
Running `julia --project make.jl` will generate the `.meta/config.json` files based on the information given in `.meta/config.toml`.
16+
17+
`.meta/config.toml` will look like this for most exercises:
18+
19+
```toml
20+
authors = [
21+
{ github = "Foo", exercism = "Foo" },
22+
]
23+
24+
contributors = [
25+
{ github = "Bar", exercism = "Bar" },
26+
]
27+
```
28+
29+
If necessary, `forked_from` and `solution` keys can be used to specify the value of `forked_from` and overwrite the name of the solution file, e.g.:
30+
31+
```toml
32+
forked_from = "javascript/boolean"
33+
solution = "game.jl"
34+
```
35+
936
## Contributing Guide
1037

1138
Please see the [contributing guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)