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:
parent
e4cc388918
commit
0b7839e61f
1 changed files with 24 additions and 0 deletions
24
README.md
Normal file
24
README.md
Normal 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.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue