From dd2fadcae26ca57ad4f159a34b80be34e2c33168 Mon Sep 17 00:00:00 2001 From: "Jess P.S" Date: Sun, 30 Mar 2025 08:56:56 -0700 Subject: [PATCH] Update Readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..99ca906 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# web-tuner + +A neat little tool for custom tuning string instruments. + +## Setup + +```bash +python -m venv venv +source venv/bin/activate # or 'venv\Scripts\activate' on Windows +pip install -r requirements.txt +``` + +## Configuration + +Edit the `config.json` file to customize your chord generation: + +- **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 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/ \ No newline at end of file