haxo-hw icon indicating copy to clipboard operation
haxo-hw copied to clipboard

Published 20 hours ago • verified publisher icon cardonabits

Write a proper manual for the Haxophone

Open jcard0na opened this issue 1 year ago • 7 comments

There is a lot of information about the Haxophone dispersed across Discussions, Issues, the docs directory, the Crowd Supply campaign page and ultimately the source code.

But there is no proper Manual. We probably need to write one.

jcard0na avatar Dec 20 '23 18:12 jcard0na

I'd happily act as a guinea pig on this. What as a newcomer who just received the device expects :

  1. how to play the first note as easily as possible (pretty much https://github.com/cardonabits/haxo-hw/blob/main/docs/Quick%20Start%20Postcard.pdf )
  2. how to connect to other stuff, e.g MIDI
  3. how to customize in standalone mode, e.g change sounds (I assume configuring https://github.com/FluidSynth/fluidsynth ), key mapping, etc
  4. how to customize "live" and wirelessly by having e.g WiFi with ssh on the RPi (using Imager which prompted me for customization made me wonder if that was already the case)

Utopiah avatar Jan 04 '24 17:01 Utopiah

I'd also add SBCs (broadly, cf https://github.com/cardonabits/haxo-hw/issues/19 ) support grid with RPi Zero highlighted as of right now (early January 2024) best supported one (which features specified, i.e MIDI USB, audio out?, no HW bug with HDMI port contact on line out, etc) with clarification on pins required (as unlike others sold with and without pins) but not RPi 2/3/4/5 or Zero 2W (cf https://github.com/cardonabits/haxo-hw/issues/53 and others, WiP AFAIK). Ideally this sorted grid would remain up to date so that newcomers and know right away if what they have can be used, what should work and if no what they should get.

Utopiah avatar Jan 05 '24 07:01 Utopiah

Why there is no reason to turn off the device (i.e real-only SD) https://github.com/cardonabits/haxo-rs/commit/9a9a84b224fc8a8fe0d9163508b1aee2d814d735 and also customization by fingering example.

Utopiah avatar Jan 11 '24 06:01 Utopiah

Hi,

I would like to help with the manual. Which option do you prefer:

  1. create a big manual.md file in the doc folder and use the same image folder as the existing doc
  2. or create a separate manual folder in the doc folder containing one or more .md files for the manual and an extra image folder

stardusthamster avatar Feb 25 '24 08:02 stardusthamster

Thanks for offering to help! Given that you'll be doing this, pick whatever format makes you happier. Full creative freedom ahead 🧑‍🎨

jcard0na avatar Feb 25 '24 10:02 jcard0na

Here is my first version of the manual: https://github.com/cardonabits/haxo-hw/pull/79

stardusthamster avatar Mar 24 '24 10:03 stardusthamster

Could be interesting to make the manual an explorable explanation, relying on MIDI mode, ideally with no install so via the Web, e.g https://webmidi-abc-chromatone.glitch.me/haxo.html

Utopiah avatar Jun 18 '24 05:06 Utopiah