Update README.md

This commit is contained in:
jess 2026-03-04 13:06:09 +00:00
parent 10962dca23
commit a4732aa4bc
1 changed files with 19 additions and 21 deletions

View File

@ -2,29 +2,27 @@
A neat little tool for custom tuning string instruments.
## Pre-requisites
- wails
- needs c and c++, aka GCC or clang/xcode-commandline-tools
- go
- inkscape (or build manually instead if you don't care about the icon)
## Setup
Mac
`./build.sh`
```bash
python -m venv venv
source venv/bin/activate # or 'venv\Scripts\activate' on Windows
pip install -r requirements.txt
```
On Windows or anywhere build.sh does not work
## Configuration
`wails build -clean`
Edit the `config.json` file to customize your chord generation:
If you are having trouble still, I'd review build.sh and figure out what you might be missing from your path.
- **Strings**: Add/remove strings and use sharps (`#`), flats (`b`), or a mix.
- **max_fingers**: Set the maximum number of fingers allowed per chord. (Note: Not always respected yet.)
- **max_frets**: Controls how far up the neck to search for chords.
> **Warning**: Even on a powerful computer, setting `max_frets` higher than `5` can slow things down *a lot*. You've been warned!
---
Run
```bash
python main.py > output.txt
```
it will be much slower if you don't output it to a file instead of the shell, but if you want to see the debugging messages, just run the command normally. That's all, playable chord shapes from any tuning you put into the config will be generated.
View them by opening chords.html, which will be generated into www/
```magic_env_lines
/** I'm talking about these ones, if you don't have valid env vars for these, that is why it isn't compiling. */
export CC=/usr/bin/clang
export CXX=/usr/bin/clang++
export SDKROOT=$(xcrun --show-sdk-path)
export PATH="$HOME/go/bin:$PATH"
```