diff --git a/README.md b/README.md index 4cf0dba..91be7b9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This project runs [fsrs-rs](https://github.com/open-spaced-repetition/fsrs-rs) in the browser with support for training FSRS parameters. -It git submodules [fsrs-rs](https://github.com/AlexErrant/fsrs-rs/tree/fsrs-browser) and [burn](https://github.com/AlexErrant/burn/tree/fsrs-browser) for reasons given [here](https://github.com/Tracel-AI/burn/pull/938#issuecomment-1925913866). As such, it will not be up to date with the latest fsrs-rs. fsrs-browser's major and minor version numbers will match the version of fsrs-rs used. The patch version number is reserved for this package's use and may drift out of sync with fsrs-rs. +## Versioning + +We git submodule [`fsrs-rs`](https://github.com/AlexErrant/fsrs-rs/tree/fsrs-browser) and [`burn`](https://github.com/AlexErrant/burn/tree/fsrs-browser) for reasons given [here](https://github.com/Tracel-AI/burn/pull/938#issuecomment-1925913866). As such, it will not be up to date with the latest `fsrs-rs`. `fsrs-browser`'s major and minor version numbers will match the version of `fsrs-rs` used. The patch version number is reserved for `fsrs-browser`'s' use and may drift out of sync with `fsrs-rs`. ## Building and demoing @@ -12,4 +14,4 @@ Run `./dev.sh` for fast builds or `./prod.sh` for fast runs. Run the `/sandbox` project to demo various behavior. -I highly encourage `./prod.sh` if you intend to run training. On my machine training 24,394 FSRS items/revlogs on `./dev` takes days, while `./prod.sh` takes 3.5 seconds. +I highly encourage `./prod.sh` if you intend to run training. On my machine training 24,394 revlogs on `./dev` takes days, while `./prod.sh` takes 3.5 seconds.