From 2a6c033427fb3902702dbf8d628c5f860d9d1799 Mon Sep 17 00:00:00 2001 From: weishaupt <1+weishaupt@noreply.localhost> Date: Mon, 19 Oct 2026 01:18:41 +0000 Subject: [PATCH] Add project root --- .gitignore | 5 +++++ README.md | 32 ++++++++++++++++++++++++++++++++ build.gradle.kts | 6 ++++++ gradle.properties | 4 ++++ settings.gradle.kts | 9 +++++++++ 5 files changed, 56 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 build.gradle.kts create mode 100644 gradle.properties create mode 100644 settings.gradle.kts diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fb67848 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.gradle/ +build/ +local.properties +*.keystore +app/src/main/assets/bible.db diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2cdfae --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Vellum + +A quiet, offline Bible reader for Android (built for the Galaxy Z Fold8). + +Scroll the whole Bible continuously or one verse a screen (Reel mode), with a Verse of the Day card, words of Jesus in steel blue (#4682B4), aged vellum, papyrus and parchment backgrounds, a candlelight night mode, and five reading fonts (Tinos, EB Garamond, Crimson Pro, IM Fell English, Cardo). + +## Features + +- Verse of the Day with Copy, Image and Open, plus a home screen widget and an optional morning notification +- Six public domain translations: KJV, WEB, BSB, ASV, YLT, Douay-Rheims, with a side by side view +- Share verses as images: square, 16:9 for X, 4:5 or 9:16 story +- Highlights in six colors, notes, bookmarks +- Strong's Hebrew and Greek word study on the KJV, cross references from openbible.info +- Search, go to any book and chapter, verses by topic +- Reading plans with streaks +- Read aloud with the phone's voice and a sleep timer, adjustable auto-scroll +- Swipe left or right to change chapter +- No account, no ads, no tracking, no internet permission + +## Install + +Grab `Vellum-1.0.apk` from this repo and open it on the phone. + +## Building + +The 48 MB `bible.db` is not stored here. Rebuild it with `tools/build_db.py` (sources: eBible.org USFM for KJV and WEB, scrollmapper bible_databases JSON for BSB, ASV, YLT and DRC, openscriptures Strong's, openbible.info cross references) into `app/src/main/assets/bible.db`. `tools/textures.py` regenerates the background textures. + +Release builds need a `vellum.keystore` in the project root (not included in this repo). Then `gradle assembleRelease`. + +## Credits + +Bible texts are public domain. Strong's dictionaries: Open Scriptures (CC BY-SA). Cross references: openbible.info (CC BY). Fonts: Tinos (Apache 2.0), the rest SIL Open Font License. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..e384077 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,6 @@ +plugins { + id("com.android.application") version "8.10.1" apply false + id("org.jetbrains.kotlin.android") version "2.1.21" apply false + id("org.jetbrains.kotlin.plugin.compose") version "2.1.21" apply false + id("io.github.takahirom.roborazzi") version "1.43.0" apply false +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..f97184b --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +org.gradle.jvmargs=-Xmx4g -Dfile.encoding=UTF-8 +android.useAndroidX=true +kotlin.code.style=official +android.nonTransitiveRClass=true diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..13b0c27 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,9 @@ +pluginManagement { + repositories { google(); maven("https://maven-central.storage-download.googleapis.com/maven2/"); mavenCentral(); gradlePluginPortal() } +} +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { google(); maven("https://maven-central.storage-download.googleapis.com/maven2/"); mavenCentral() } +} +rootProject.name = "Vellum" +include(":app")