Update readme, add version requirement

TTWNO · Jun 10, 2024 · 616255b · 616255b
1 parent 9555c74
commit 616255b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,12 @@ It is up the user what they will do with this data.
 
 If `mediainfo` displays different information than this for `[a-z].wav`, then you may need to change the settings in the constants of `calc.py` to produce the right sized padded/raw files.
 
+## `fry_normalize`
+
+`fry_normalize` is the beginning of a text-to-speech engine written entirely in Rust.
+This module only normalizes text to be a restircted, known form.
+Check out [`fry_normalize`'s README](./fry_normalize/README.md) for more information.
+
 ## TODO
 
 * [ ] Add some tests to verify that bit patterns are indeed concatonated correctly.

diff --git a/fry_normalize/Cargo.toml b/fry_normalize/Cargo.toml
@@ -2,6 +2,7 @@
 name = "fry_normalize"
 version = "0.1.0"
 edition = "2021"
+rust-version = "1.80"
 
 [dependencies]
 num2words = { git = "https://github.com/TTWNO/num2words", branch = "no-std-support" }

diff --git a/fry_normalize/README.md b/fry_normalize/README.md
@@ -0,0 +1,10 @@
+# `fry_normalize`
+
+This module of `fry` attempts to normalize various parts of speech into known formats, starting with:
+
+- Words
+- Symbols
+- Abbreviations
+- Numbers
+
+This module requires Rust version `1.80`.