From f128e258006bb34f10d30982d3f6f41c0728c0e2 Mon Sep 17 00:00:00 2001 From: Paul Walker Date: Sun, 29 Dec 2024 20:35:41 -0500 Subject: [PATCH] Improve the README; placeholder the manual --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++- doc/design.md | 8 ++++---- doc/manual.md | 5 +++++ 3 files changed, 61 insertions(+), 5 deletions(-) create mode 100644 doc/manual.md diff --git a/README.md b/README.md index b816a06..60c153e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,54 @@ # Six Sines -Maybe, before 1 Jan 2025, as a new years present, Six Sines will get released. \ No newline at end of file +Six Sines is a small synthesizer which explores audio rate inter-modulation of signals. +Some folks would call it "an FM synth" but it's really a bit more PM/AM, and anyway that's +kinda not the point. + +If you want to read a manual, [go here](doc/manual.md) + +If you want to download a release or recent version, [go here](releases) + +## Background + +The project exists for a few reasons + +1. At the end of 2024, I was in a bit of a slump dev-wise for a variety of reasons and wanted a + small project to sort of jump-start me for 2025. I had watched [Newfangled Dan ship obliterate](https://www.newfangledaudio.com/obliteratefrom +from idea to loved plugin in November, and I thought hey can I do the same in December +2. As I wrapped up 2024, I also wanted to take account of how well our project to factor code into libraries +went and make a sort of todo-list of why it was hard to build a synth. This includes some +insights into the sst- libraries and the clap-wrapper +2. Another india audio dev, who asked to not be named here in case this sucks, which it doesn't I dont think, +said to a group of users in a discord "the most useless thing is a 6 op fill matrix pure FM synth". +3. It seemed fun, and I thought some people would download it. +4. It had been in my head for a while and I wanted to hear how it sounded + +## How to build this software + +We provide pre-build windows, linux, and macOS binaries at the [release page](releases) but especially on +Linux, you may want to build it yourself, since we use ubuntu 24 machines and linux doesn't really exist. + +So to build it, do the standard + +```aiignore +git clone https://github.com/baconpaul/six-sines +cd six-sines +cmake -Bignore/build -DCMAKE_BUILD_TYPE=Release +cmake --build ignore/build --config Release --target six-sines_all +``` + +various plugins and executables will now be scattered around ignore/build. + +## I found a bug or want a feature added + +So this was really a one month sprint. And its pretty self contained thing. So feature requests +are things I may say no to. But open an issue and chat. Or send a PR! + +Bugs especially let me know. + +But remember, "Programming an FM/PM/RM synth is hard" is not a bug in six-sines! + +## Why is this a `baconpaul` and not a `surge-synthesizer` project + +Well you know. It's not quite up to snuff for a surge project. And its pretty idiosyncratic. +I may do a few more side quest projects in 2025. Lets see. \ No newline at end of file diff --git a/doc/design.md b/doc/design.md index e339f44..6b35987 100644 --- a/doc/design.md +++ b/doc/design.md @@ -21,11 +21,11 @@ GENERAL AND CLEANUPS - Toggles and Multiswitches dont have accesible set actions - Show menu doesnt work for set value - Ctrl/Knob quantizes on ratio to PO2 -- AM is somehow not quiet right. Signal to zero seems 'no modulation' not 'no output' -- Write a better README -- Write some semblance of documentation +- Write some semblance of a manual -THINGS I DIDNT DO +THINGS I DIDNT GET TO FOR 1.0 +- AM is somehow not quiet intuitive. Modulator signal to zero results in 'no output' but it sort of intuitively should me + 'no modulation' - 90%-100% of internal nyquist mute fades (maybe ship without this tho) - Main DAHDSR at DAHD=0 SR=1 means voice lifetime is longest active op mixer DAHDSR and main DAHDSR bypassed - Note Expressions diff --git a/doc/manual.md b/doc/manual.md new file mode 100644 index 0000000..9c32d5e --- /dev/null +++ b/doc/manual.md @@ -0,0 +1,5 @@ +# Six Sines Manual + +It has knobs. Play with them! + +(More coming soon)