From a4732aa4bc09e316736a84da1ec675355711fb85 Mon Sep 17 00:00:00 2001 From: jess Date: Wed, 4 Mar 2026 13:06:09 +0000 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e0464e4..90c2f82 100644 --- a/README.md +++ b/README.md @@ -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" +``` \ No newline at end of file