Add project documentation

- Create comprehensive README with feature overview
- Include build instructions for devkitPro toolchain
- Add usage instructions and safety warnings
- Professional documentation for project release
This commit is contained in:
badblocks 2023-05-24 18:22:14 -07:00
parent e4cc388918
commit 0b7839e61f
No known key found for this signature in database

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# BOTW Completer
Nintendo Switch homebrew tool for managing Korok seed locations in Breath of the Wild.
## Features
- Add missing Korok seed pins to your map
- Remove all existing map pins
- Fix corrupted map pin data
- Sort Koroks by distance from player
## Building
Requires devkitPro toolchain:
```bash
make
```
## Usage
Run via homebrew launcher. Use the on-screen menu to select options.
**Warning:** This modifies save data. Back up your saves first.