-
Notifications
You must be signed in to change notification settings - Fork 0
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
Specify the dependencies in README #1
Comments
This one's a bit tricky, as this plugin has no dependencies like that but because I marked plover-midi as a convenience dependency that users likely want to install together it means plover-midi's dependencies affect this installation I'd rather not try to detail the exact dependencies of plover-midi for Linux as part of the README here as that's documentation that should live on plover-midi and could become out of sync / date with it easily. Two possible options:
1 seems easiest in terms of responsibility separation, but I'll ask Sillabix if he's super opposed to it as it means his manual needs to have an extra step in it. For what it's worth, Windows 10 and MacOS don't seem to need anything for plover-midi to work out of the box (confirmed on both). |
Understood the situation. Without knowing anything, I'd say the best seems to remove plover-midi as a dependency and tell in the README that people may want to install it and why. But I'll leave up to you to decide the best course of action. I hope that benoit add that info in plover-midi anyway. Thanks! |
To ease the life of new users, I'd help if the README included something like
On Linux this package depend on
pkg-config
,libasound2-dev
and eitherlibjack-dev
orlibjack-jackd2-dev
(and gcc) and you will have to install them withapt
oryum
.I assume a similar verbiage would apply for windows/mac, but I am not sure.
Related to openstenoproject/plover#1108
The text was updated successfully, but these errors were encountered: