Sort out documentation - Githubissues

Chordian / sidfactory2

SID Factory II is a cross-platform editor for composing music that will work on a Commodore 64. It uses the reSID emulator and is currently in open BETA.

http://blog.chordian.net/sf2/

112 stars 13 forks source link

Sort out documentation #80

Open micheldebree opened 3 years ago

micheldebree commented 3 years ago

Documentation is a bit cumbersome to maintain. Now:

A docx file that is manually converted to pdf
A notes.txt with all the default key bindings for windows and macos
A keys.md with keybindings for macos (that is converted at build time to html)
A config.ini that has the default keybindings (need to be in sync with the bindings in the code)

Ideas:

Only one file for default key bindings (replaces notes.txt and keys.md)
Automatic conversion of the pdf from docx? And remove the pdf from the repo?
Use markdown for all the documentation and generate pdf at build time?
Publish the documentation automatically on the Github wiki (how?)

Chordian commented 3 years ago

We could just rename notes.txt to e.g. keys.txt instead?

holovicc commented 5 months ago

I hope i add this to the right place:

notes_driver11.txt says for the wavetable: "00-7f = semitones added to note in sequence 80-df = absolute semitone value (use for e.g. drums)"

It does not seem to be right.

$01->$67 seems to transpose up $7f->$68 seems to transpose down $80->does not seem to do anything $81->$df absolute note values

Also, i'd prefer a shortcut like altering between negative and positive transpose. How? Entering 03 then hitting a shortcut would turn this into a -03 equivalent and vice versa.