diff --git a/README.md b/README.md index 07c02f4..38c3259 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,32 @@ HemiTyper is a typing trainer that provides you with only half the keyboard per session, to help you improve coordination of each hand separately. -Written in pure Rust using [Dioxus](https://github.com/dioxuslabs/dioxus) - -Available at [hemi.kualta.dev](https://hemi.kualta.dev/) +Written in pure Rust using [Dioxus](https://github.com/dioxuslabs/dioxus). Supported layouts: - Qwerty - Colemak + +Available at [hemi.kualta.dev](https://hemi.kualta.dev/) + + - +### Building +use [Dioxus CLI](https://github.com/DioxusLabs/dioxus/tree/master/packages/cli) to build and serve locally: +```sh +cargo install dioxus-cli +``` +to build run +```sh +dx build +``` +to serve on localhost run +```sh +dx serve --hot-reload +``` +to compile tailwind classes run +```sh +npx tailwindcss -i ./assets/style.css -o ./assets/tailwind.css +``` ### Contributing The tool is considered complete, but PRs are still welcome.