diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 00000000..f61d21dd --- /dev/null +++ b/HACKING.md @@ -0,0 +1,7 @@ +# Hacking on compose-lobsters + +This app is built as a very lightweight frontend for [lobste.rs](https://lobste.rs), mainly as an experiment in using [Jetpack Compose](https://d.android.com/jetpack/compose). + +The codebase is fairly simple, and the package structure follows [Buffer's](https://buffer.com/resources/android-rethinking-package-structure/). + +We use screenshot testing for our UI, and a script is included in the `scripts` directory to create an emulator that will exactly match the one in our CI so you can deterministically replicate the setup for locally running tests.