askiiart/cat2text-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
askiiart 2025-01-12 13:57:57 -06:00
parent 79dbcb1d3d
commit 39ebf700e7
Signed by untrusted user who does not match committer: askiiart
GPG key ID: 6A32977DAF31746A
2 changed files with 57 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2,7 +2,7 @@
This is a port of [Cat2Text](https://github.com/askiiart/Cat2Text) to Rust, with extra functionality, better documentation, and support for using it as a library as well.
## Base4 Format
## Base 4 Format
Using the original base4 format, it works like this. First off, each word is equal to a value in base 4:
@ -13,7 +13,29 @@ Using the original base4 format, it works like this. First off, each word is equ
| 2 | mreow |
| 3 | mrow |
Then, the text is converted into lowercase
Then, the text is converted into lowercase, 96 is subtracted from its ASCII value (i.e. "a" (97) -> 1), and it's converted to base 4, which is then replaced by the cat sounds above; Each cat sound is separated by a space (" "), then each word is delimited by a semicolon and a space ("; ").
For example, "i love cats" is translated into:
> meow mreow mrrp; meow mrow meow meow mrow mrow mrrp mrrp mreow meow mrrp mrrp; meow meow mrow meow meow mrrp mrrp mrrp meow mrrp meow mrow
Separating out the letters and words:
> [
> ["meow mreow mrrp"],
> [
> "meow mrow meow",
> "meow mrow mrow",
> "mrrp mrrp mreow",
> "meow mrrp mrrp"
> ],
> [
> "meow meow mrow",
> "meow meow mrrp",
> "mrrp mrrp meow",
> "mrrp meow mrow"
> ]
> ]
## Limitations