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

document onscreen keyboard setup in README.md #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

GorgiAstro
Copy link
Collaborator

@GorgiAstro GorgiAstro commented May 4, 2022

This merge request contains no code, it only documents how to set up the onboard virtual keyboard to be used in Mixxx.

Actions required:

  • Can someone else test it on Raspberry Pi OS?
  • Can someone test it on Ubuntu? Some instructions maybe only work for Raspberry Pi OS
  • Where is the best place for this documentation? It takes a lot of space in README.md.

@timewasternl
Copy link
Owner

I'm thinking of creating a folder called "extras" or "integrations" for such things, as they will contain optional integrations. In there, we can create separate markdown files per feature.
In there, we can also link the project by @bencejuhaasz (https://github.com/bencejuhaasz/Pioneered-Plus) for deeper integration with the controller mapping for the DDJ-400.

I will test the instructions later today.

@bvobart
Copy link
Collaborator

bvobart commented Aug 9, 2022

Where is the best place for this documentation?

I'm thinking of creating a folder called "extras" or "integrations" for such things, as they will contain optional integrations. In there, we can create separate markdown files per feature.

Hmmm, don't think that'd be nice in this repo for people who just want to download the skin, might be better to do it in a separate repo such as Pioneered Plus or maybe on a Wiki on this repo, if you enable that in the repo's settings.


Nice guide though, clear and beginner-friendly with helpful pictures :) It is very Raspberry Pi OS specific, yes. The installation command probably works on Ubuntu too (on Manjaro ARM -- which is what I run on my own RPi -- it's sudo pacman -S onboard), but the UI and where to add it to the startup apps could be completely different for anything else than the Pi OS' PiXeL desktop environment.

@timewasternl
Copy link
Owner

timewasternl commented Aug 11, 2022

[...]or maybe on a Wiki on this repo, if you enable that in the repo's settings.

Great idea, totally forgot about this feature.
I have enabled it and added you all as contributor :)

@GorgiAstro, would you like to take the honour of putting your documentation on the first Wiki page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants