Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgroenwoldt committed Jun 16, 2023
1 parent 0861d63 commit e16f01d
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,21 @@ A web quiz built with [yew](https://yew.rs/) for testing your knowledge of [heli

![helix-shortcut-quiz](https://user-images.githubusercontent.com/70777530/228351818-b7ebe8f2-a672-4759-86ab-e395c9cf211b.gif)

## Development
## How to play
| Key | Action |
|----------|:-------------:|
`Esc` | Clear input
`Backspace` | Pop last char of input
`Enter` | Submit correct input
`Left arrow` | Skip to left GIF
`Right arrow` | Skip to right GIF

Your category progress is stored in the local storage of your browser. You can reset this store via the `Reset this category`
button.

#### Installation
## Development

###### Frontend
### Dependencies

If you don't already have it installed, it's time to install Rust: <https://www.rust-lang.org/tools/install>.

Expand All @@ -26,7 +36,7 @@ Install trunk:
cargo install trunk
```

###### GIF generation
### GIF generation

The `yew` app serves GIFs generated by [`vhs`](https://github.com/charmbracelet/vhs). The current state of `vhs` doesn't
support the recording of the helix block cursor. The problem lies deeper within the [`ttyd`](https://github.com/tsl0922/ttyd)
Expand All @@ -35,8 +45,11 @@ dependency which uses the [`xterm.js`](https://github.com/xtermjs/xterm.js) canv
If you want to generate the GIFs yourself you should go ahead, clone the custom forks I made and use those binaries instead.
After building the two binaries place them in the `gif_generation/` directory and execute `generate_all_gifs.sh`.

#### Running
### Run the application locally

```bash
trunk serve
```

## Contributing
Any kinds of contributions are welcome! Feel free to reach out to me via issues or pull requests :)

0 comments on commit e16f01d

Please sign in to comment.