-
Notifications
You must be signed in to change notification settings - Fork 162
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
Update compilation instructions #635
Comments
Since I was confused, for the potential benefit of future readers: The file In the (otherwise unrelated) issue #503 @basisbit indicated that they'd rather move documentation in general to the wiki. If that is still the case, it seems to me that it would also make sense to have the compilation instructions there and get rid of them in the README (just having a link to the wiki, I guess) so that future inconsistencies are avoided. But this has the disadvantage that the process of contributing to the wiki is not documented and capital-PR Pull Requests don't work. [1] [1]: You may however pull from https://github.com/HermannDppes/USDX.wiki.git where the compilation instructions match the README and I made some other changes years ago without remembering their rationale by now … which is not exactly optimal. |
@HermannDppes doesn't that issue have a different target audience though? That's more for end users, whereas compilation instructions is much more a developer thing. As such, personally I'd rather keep it in the repo (perhaps in a separate As for the actual issue here, I used the Arch package as a starting point on my system, but I need to see what modifications I made. Especially things like the The freefont vs dejavu thing feels logical (I think a similar thing happened in Arch at some point), so that should at least be pretty easy to fix in the README. Not sure what to do about the wiki though, though if there's no other differences, could just turn it into a placeholder page that only links to here for the time being? |
I don't really mind, where it is documented. To me it feels more important to have it consistent and avoid redundancies. Therefore removing the wiki content and putting a link to the README seems fine. |
The README should now be better, but I'll keep this ticket open until the wiki has also been updated. I'll create a wiki PR for that hopefully within a week. |
I've made some updates to the wiki and opened #653 to make the README a bit smaller while I was at it. |
This is absolutely possible and the syncing can also be automated with GitHub-actions, it seems. |
The branch is now merged into master, and for the wiki I've created follow-up item #660 |
Thanks for the updates. The instructions in the README.md work for me now. |
Actual behaviour
The Ubuntu compilation instructions for Ubuntu in the Readme.md and in the wiki differ and partially don't work.
Expected behaviour
The compilation instructions provide a way to successfully compile Ultrastar Deluxe. They are consistent (e.g. by only having them in one place).
Steps to reproduce
./autogen.sh
mentioned in the Readme.md is missing.The needed package from Ubuntu 22.04 onwards seems to be named
fonts-dejavu
and thettf-freefont
package seems to be redundant.Greetings Nmxcgeo
The text was updated successfully, but these errors were encountered: