Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fearful-symmetry committed Feb 18, 2024
1 parent a9c0749 commit 05e7109
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The [bureaucracy](examples/bureaucracy/) example demonstrates this by generating

Kirum is a work in progress, and should be considered alpha software.


## Installing

If you haven't already, install [rust](https://rustup.rs/) and [git](https://github.com/git-guides/install-git). Once you've cloned the repo, install with
Expand Down Expand Up @@ -45,6 +46,7 @@ The [`examples`](examples) directory has a number of projects:
- [conditionals](examples/conditionals/) - Using conditional statements in transforms.
- [phonetic_rules](examples/phonetic_rules/) - Using Kirum's phonetic rulesets to generate words.
- [ingest_from_json](examples/ingest_from_json/) - Ingesting words into a language project from a JSON or newline-delimited text file.
- [rhai](examples/rhai/) - Using the [Rhai](https://github.com/rhaiscript/rhai/tree/main) scripting language to transform words as part of an etymological history.


## The structure of a Kirum project
Expand Down

0 comments on commit 05e7109

Please sign in to comment.