From 4662dea1b8992bace4344c481e20796696bd0558 Mon Sep 17 00:00:00 2001 From: Freya Murphy Date: Sun, 30 Nov 2025 15:16:02 -0500 Subject: readme: add crates and fix typos --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e62a2fe..6d61910 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ A rust Dungeon Crawler! ## Keybinds -Use the following input for playing the game~ +Use the following input for playing the game! * `wasd` or `↑←↓→` for movement * `enter` for interaction -* `e` to use an itemm +* `e` to use an item * `q` to drop an item * `f` to attack * `1-5` to change selected inventory slot @@ -52,7 +52,17 @@ To build for web, invoke the makefile. The output website will be in `dist`. make web ``` -Web builds can also be download at [jenkins](https://jenkins.freya.cat/job/DungeonCrawl/)/ +Web builds can also be download at [jenkins](https://jenkins.freya.cat/job/DungeonCrawl/). + +## Crates + +`dungeon` - all game logic + +`game` - core game loop, and binds together the game logic and graphics + +`graphics` - handles window and rendering though raylib + +`audio` - audio orchestration system that emulates the NES ## Features -- cgit v1.2.3-freya