Add a readme

2026-09-15 09:41:04 +02:00
parent 18dcff18b1
commit 493fa91d0c
2 changed files with 17 additions and 0 deletions
@@ -0,0 +1,17 @@
 # cdungeon ▲̶͈̊
 ![cdungeon demo Gif](./demo.gif)
 > What if `cd` was a terminal based dungeon crawler?
 Run this project:
 ```
 cargo run --release
 ```
 Add a `cdg` command to your shell that allows you to interactively change directories using `cdungeon`:
 ```
 source ./activate
 ```