search

GrapheneOS / PdfViewer

Simple Android PDF viewer based on pdf.js and content providers. The app doesn't require any permissions. The PDF stream is fed into the sandboxed WebView without giving it access to content or files. CSP is used to enforce that the JavaScript and styling properties within the WebView are entirely static.
https://grapheneos.org/
MIT License
598 stars 98 forks source link

Development setup guidelines #373

Closed TanguyP closed 3 months ago

TanguyP commented 3 months ago

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? :scream_cat:)

thestinger commented 3 months ago

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

TanguyP commented 3 months ago

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)

TanguyP commented 2 months ago

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

thestinger commented 2 months ago

@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.