Added readme and other docs

hbmartin · hbmartin · commit 91fa4955e662 · 2025-05-17T15:43:16.000-07:00
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -18,6 +18,12 @@ jobs:
         with:
           distribution: temurin
           java-version: 21
+          cache: 'gradle'
+          cache-dependency-path: |
+            gradlew
+            settings.gradle.kts
+            build.gradle.kts
+            app/build.gradle.kts
       - name: Run Detekt on the detekt rules
         uses: gradle/gradle-build-action@v3
         with:
diff --git a/.idea/deploymentTargetSelector.xml b/.idea/deploymentTargetSelector.xml
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,19 @@
+Copyright (c) 2025 Harold "Roldy" (Martin) Martin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# GoL Screensaver
+
+[![CodeFactor](https://www.codefactor.io/repository/github/hbmartin/onyx-boox-screensaver-gol/badge)](https://www.codefactor.io/repository/github/hbmartin/onyx-boox-screensaver-gol)
+[![Lint](https://github.com/hbmartin/onyx-boox-screensaver-gol/actions/workflows/lint.yml/badge.svg)](https://github.com/hbmartin/onyx-boox-screensaver-gol/actions/workflows/lint.yml)
+
+GoL Screensaver is an app that generates and updates screensavers for Onyx Boox using [Conway's Game of Life Algorithm](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life). Optimized for e-ink screens!
+
+## Screenshot
+<img src="media/screenshot.png" width="300" />
+
+## 🎨 Features
+- Auto-updating screensaver based on Conway's Game of Life
+  - Note that wallpaper will not update while the screen is locked, only on the next unlock -> lock.
+
+- Customizable foreground and background colors
+- Pattern picker for common Game of Life starting states
+
+## 🏄 Usage
+1. **Install the app** on your Android device using F-Droid.
+2. **Disable freezing in order to for the game to update**
+   1. Settings > Apps & Notifications > Freeze Settings > GoL Wallpaper (OFF)
+   2. Note: Updates happen at most every 15 minutes and **only** with sufficient battery
+
+3. **Launch the app**:
+   - (Optional) Choose foreground and background colors in the app
+   - (Optional) Pick a starting pattern 
+   - (Optional) Tap "Generate Next Step" to advance the Game of Life and update your wallpaper
+
+## 🤝 Contributing
+
+[Pull requests](https://github.com/hbmartin/onyx-boox-screensaver-gol/pulls) and [feature requests / bug reports](https://github.com/hbmartin/onyx-boox-screensaver-gol/issues) are welcome!
+
+This project uses Kotlin and Jetpack Compose with **no** 3rd party dependencies and is checked by [detekt](https://detekt.dev/) with [hbmartin's rules](https://github.com/hbmartin/hbmartin-detekt-rules).
+
+1.  Fork the repository and `git clone`
+2.  Create a new branch `git checkout -b cool-feature-name`
+3.  Open in Android Studio, sync Gradle, and start hacking!
+4.  Ensure checks are passing by running `./gradlew detektMain`
+5.  Commit your changes `git commit -am 'Description of what changed'`
+6.  Push to the branch `git push origin head`
+7.  Create a new [Pull Request](https://github.com/hbmartin/onyx-boox-screensaver-gol/pulls)
+
+### Project Structure
+- `app/src/main/java/me/haroldmartin/golwallpaper/` – Main source code
+  - `domain/` – Game of Life logic and patterns
+  - `ui/` – Jetpack Compose UI components
+  - `utils/` – Utility functions (saving wallpaper, color picking, etc.)
+
+## ✍️ Authors
+
+* [Harold Martin](https://www.linkedin.com/in/harold-martin-98526971/) - harold.martin at gmail dot com
+* Triangle disclosure icon from [Compose Icons / Lucide](https://composeicons.com/icons/lucide/triangle)
+* Inspiration from [WanderWall by fmeyer](https://github.com/fmeyer/WanderWall)
+
+## ⚖️ License
+[MIT License](LICENSE.txt) with addendum: it's legally required for you to do at least one of have fun with this or report an issue explaining why not, no takesies backsies.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -66,7 +66,7 @@ dependencies {
     debugImplementation(libs.androidx.ui.test.manifest)
 
     detektPlugins(rootProject.libs.detekt.formatting)
-    detektPlugins("me.haroldmartin:hbmartin-detekt-rules:0.1.6")
+    detektPlugins(rootProject.libs.detekt.hbmartin)
 }
 
 tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
diff --git a/app/src/main/java/me/haroldmartin/golwallpaper/MainScreen.kt b/app/src/main/java/me/haroldmartin/golwallpaper/MainScreen.kt
@@ -34,7 +34,7 @@ fun MainScreen(viewModel: MainViewModel = viewModel()) {
     ) {
         Text(
             "NOTE! You must disable freezing in order to for the game to update:\n" +
-                "Settings > Apps & Notifications > Freeze Settings > GoL Wallpaper (OFF)",
+                "Settings > Apps & Notifications > Freeze Settings > GoL Screensaver (OFF)",
         )
         ColorPicker("Foreground Color", uiState.fgColor) { color ->
             viewModel.setFgColor(context, color)
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -1,3 +1,3 @@
 <resources>
-    <string name="app_name">GoL Wallpaper</string>
+    <string name="app_name">GoL Screensaver</string>
 </resources>
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,4 +4,14 @@ plugins {
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.kotlin.compose) apply false
     alias(libs.plugins.detekt) apply false
+    alias(libs.plugins.updatesCheck)
+}
+
+tasks.withType<com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask> {
+    checkForGradleUpdate = true
+    rejectVersionIf {
+        listOf("-RC", "-Beta", "-alpha", "-rc", "-beta", "-dev").any { word ->
+            candidate.version.contains(word)
+        }
+    }
 }
diff --git a/code_of_conduct.md b/code_of_conduct.md
@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by emailing:
+harold.martin at gmail dot com
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -12,6 +12,8 @@ onyxsdkDevice = "1.2.32"
 datastore = "1.1.6"
 detekt = "1.23.8"
 androidxWork = "2.10.1"
+updatesCheck = "0.52.0"
+hbmartinRules = "0.1.7"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -33,9 +35,12 @@ androidx-material3 = { group = "androidx.compose.material3", name = "material3"
 androidx-work-runtime = { group = "androidx.work", name = "work-runtime-ktx", version.ref = "androidxWork" }
 onyxsdkDevice = { group = "com.onyx.android.sdk", name = "onyxsdk-device", version.ref = "onyxsdkDevice" }
 detekt-formatting = { group = "io.gitlab.arturbosch.detekt", name = "detekt-formatting", version.ref = "detekt" }
+detekt-hbmartin = { group = "me.haroldmartin", name = "hbmartin-detekt-rules", version.ref = "hbmartinRules" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
 detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
+updatesCheck = { id = "com.github.ben-manes.versions", version.ref = "updatesCheck" }
+
diff --git a/media/screenshot.png b/media/screenshot.png
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -27,5 +27,5 @@ dependencyResolutionManagement {
     }
 }
 
-rootProject.name = "GoL Wallpaper"
+rootProject.name = "GoL Screensaver"
 include(":app")

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ dependencies {`
`66`	`66`	`debugImplementation(libs.androidx.ui.test.manifest)`
`67`	`67`
`68`	`68`	`detektPlugins(rootProject.libs.detekt.formatting)`
`69`		`- detektPlugins("me.haroldmartin:hbmartin-detekt-rules:0.1.6")`
	`69`	`+ detektPlugins(rootProject.libs.detekt.hbmartin)`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ fun MainScreen(viewModel: MainViewModel = viewModel()) {`
`34`	`34`	`) {`
`35`	`35`	`Text(`
`36`	`36`	`"NOTE! You must disable freezing in order to for the game to update:\n" +`
`37`		`- "Settings > Apps & Notifications > Freeze Settings > GoL Wallpaper (OFF)",`
	`37`	`+ "Settings > Apps & Notifications > Freeze Settings > GoL Screensaver (OFF)",`
`38`	`38`	`)`
`39`	`39`	`ColorPicker("Foreground Color", uiState.fgColor) { color ->`
`40`	`40`	`viewModel.setFgColor(context, color)`