Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write a proper manual for the Haxophone #46

Open
jcard0na opened this issue Dec 20, 2023 · 7 comments
Open

Write a proper manual for the Haxophone #46

jcard0na opened this issue Dec 20, 2023 · 7 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jcard0na
Copy link
Collaborator

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 jcard0na added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 20, 2023
@Utopiah
Copy link

Utopiah commented Jan 4, 2024

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
Copy link

Utopiah commented Jan 5, 2024

I'd also add SBCs (broadly, cf #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 #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
Copy link

Utopiah commented Jan 11, 2024

Why there is no reason to turn off the device (i.e real-only SD) cardonabits/haxo-rs@9a9a84b and also customization by fingering example.

@stardusthamster
Copy link
Collaborator

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

@jcard0na
Copy link
Collaborator Author

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

@stardusthamster
Copy link
Collaborator

Here is my first version of the manual:
#79

@Utopiah
Copy link

Utopiah commented Jun 18, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants