Created a README.md

leslieyip02 · Jan 20, 2023 · bbad030 · bbad030
1 parent a58f9a7
commit bbad030
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# Racing 🚗
+
+![demo gif](./assets/gifs/demo.gif)
+
+site: https://leslieyip02.github.io/racing/
+
+## Controls
+Action            | Button(s)                        
+----------------- | -------------------------------- 
+Move forward      | <kbd>w</kbd>
+Move backward     | <kbd>s</kbd> / <kbd>shift</kbd>
+Turn left         | <kbd>a</kbd>
+Turn right        | <kbd>d</kbd>
+Increase thrust   | <kbd>↑</kbd> / 🖱️ scroll up             
+Decrease thrust   | <kbd>↓</kbd> / 🖱️ scroll down
+Reverse camera    | <kbd>r</kbd>    
+
+## Speedrun "Tech"
+#### *These are features, not bugs*
+
+### Shortcuts
+When passing through a checkpoint, the system only checks that it's index is greater than the vehicle's current checkpoint. This allows checkpoints to be skipped by jumping between segments of the track.
+
+![shortcut gif](./assets/gifs/shortcut.gif)
+
+### Jumps
+A delta time value is passed into the scene everytime its `update()` method is called. This `dt` value keeps increasing even the page is not being loaded or updated. 
+
+Tabbing between pages can cause the vehicle to "jump" because its displacement from its current position is equal to its `velocity` multiplied by `dt`. 
+
+![jump gif](./assets/gifs/jump.gif)
diff --git a/assets/gifs/demo.gif b/assets/gifs/demo.gif
diff --git a/assets/gifs/jump.gif b/assets/gifs/jump.gif
diff --git a/assets/gifs/shortcut.gif b/assets/gifs/shortcut.gif