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

Major refactor: Build Instructions #12

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

herzenschein
Copy link

@herzenschein herzenschein commented Mar 27, 2023

The previous build and installation instructions were extremely old and broken. I've seen many users confused about how to install it.

This at least provides:

  • Installation instructions so people don't immediately build from source
  • List of build dependencies (more distros need to be added)
  • Build and install as root
  • Build and install as user
  • Non-make-dependent build instructions
  • Minimal debugging tips
  • How it is used internally in at least one environment

The list of install packages per distribution can be reduced to simply maliit-framework maliit-keyboard for all distros once openSUSE renames their package, it's planned.

The current home build steps don't quite work, but I'd really like if they do. This is the only blocker making this a Draft. As is, maliit appears in the list of Virtual Keyboards in Plasma, and the widget even appears there. But it does not show up, and it mentions no errors. I'm assuming, without looking at the code, that there's some root related stuff happening that hinders it from running, because the same procedure run as root works fine.

Also, compiled in the home folder, it complains about a missing /usr/share/maliit/keyboard2/sounds/key_tick2_quiet.wav, causing a runtime warning. That sound file weirdly enough never gets generated if you compile as user.

We can leave the home build instructions for a later PR so as not to block this one.

When this is merged, I can make some short PRs to address the build instruction documentation in maliit/framework and maliit/keyboard.

Closes #11

@herzenschein herzenschein marked this pull request as ready for review April 1, 2023 21:36
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.

Documenting a setup that works on Opensuse tumbleweed.
2 participants