Development setup guidelines

Question

Development setup guidelines

Closed this issue 4 months ago · 4 comments

Hi, I'm considering contributing to this project, and while setup was not incredibly difficult, it still took some figuring out.

Someone more well-versed than me in the technologies and tools used might see setup as obvious, but I think it wouldn't hurt to document the gist of it. I've set it up in Fedora and Manjaro, so I can write a first basic version of such documentation (distro-agnostic, potentially OS-agnostic too), but I thought of gathering feedback here before opening a PR.

Is it ok to add this to the README? Or would you document it elsewhere? (Or not at all? 🙀)

Answer 1 · 2024-07-06T14:57:04.000Z

Setup of development on PDF Viewer was incredibly difficult, or do you mean building GrapheneOS?

Answer 2 · 2024-07-06T15:01:49.000Z

Setup was not incredibly difficult :) but I mean that despite that, it would still be helpful to have a short setup guide for developers. (I'm talking about setup of the PDF Viewer project i.e. all the steps between having it cloned on your machine and testing your local changes on a physical/virtual device)

Answer 3 · 2024-07-15T08:32:14.000Z

Hi, I'm not sure I understood the reason for closing this ticket, could you please clarify?

Answer 4 · 2024-07-15T19:28:24.000Z

@TanguyP It could be put in https://grapheneos.org/build. For the most part, it should be the same for each of our apps built with Gradle, so it belongs in our build page and could be linked here. Don't really want to put guides on building each app we'd have to maintain for a dozen apps.