Files
Incido/README.md
T
Incido Developer ab26fe5f98
dev / Build debug APK (push) Successful in 46s
release / Build & attach release APK (push) Failing after 28s
fix(release): v0.3.8.1 emergency rebuild, reinstall required
Re-release v0.3.8.0 unchanged so the repaired pipeline can actually publish it: the v0.3.8.0 run was cancelled and never produced a release or APKs.

The build ran on a runner with an empty keystore cache, so CI minted a NEW signing key: installs cannot be upgraded in place (signature conflict), and with allowBackup=false an uninstall takes the user's notes. The release notes, README, and in-app What's New now all lead with export-a-backup-first.

Lockstep per Dev Plan 11.1: versionCode 33->34, versionName -> 0.3.8.1, APP_VERSION, README, PREVIOUS_HISTORY section, ReleaseNotes.RECENT (0.3.5.1 drops off the tail), Dev Plan 10 row.
2026-09-17 18:07:41 +12:00

208 lines
7.0 KiB
Markdown

# Incido
> **Your notes. Your device. Your terms.**
Incido is a privacy-first, on-device note-taking application for Android.
All data stays on your device by default — no accounts, no cloud, no
trackers.
This repository contains the **v0.3.8.1** release: a single-user, offline
note app with hashtags, favourites, task lists, shopping lists with a
running total, colour-coded notes, photo and file attachments,
share-into from other apps and the
web, Trash (soft delete with Restore / permanent delete), at-rest
AES-256-GCM encryption with screenshot blocking, PIN / biometric lock,
encrypted backup and restore, and an exportable encryption key for
device migrations. The architecture is multi-module Android today and
is structured so iOS / Desktop ports can happen later without UI
rewrites.
**Current release:** v0.3.8.1 — full release notes ship **on its entry on
the [Releases page](https://git.trevena.info/nick/incido/releases)**.
> **v0.3.8.1 needs a clean reinstall** (a new CI signing key makes it conflict
> with any existing Incido install). **Export a backup from
> Settings → Backup first** — Incido doesn't use Android's automatic backup, so
> uninstalling deletes your notes. Otherwise this build is identical to
> v0.3.8.0.
> **Version scheme (from v0.3.0.0 onwards):** `MAJOR.MINOR.MAINTENANCE.EMERGENCY` —
> e.g. `0.3.0.0`. `MAJOR.MINOR.MAINTENANCE` are normal release numbers;
> `EMERGENCY` is non-zero only for hotfixes shipped out-of-band.
> `versionCode` is a monotonic int and always +1 per release.
> An empty MAINTENANCE/EMERGENCY slot is written as `0`.
> The build refuses to compile if `versionName` doesn't match this shape.
---
## Roadmap
See [`Incido Development Plan.txt`](./Incido%20Development%20Plan.txt) at
the repository root for the canonical backlog, including on-device ML,
cross-platform ports, end-to-end sync, and security features.
---
## Changelog
Release notes now live **on the Releases page**: every Incido release entry
ships the full changelog for exactly that version — rendered in the
release description and attached beside the APKs as
`Incido-<version>-changes.md` (generated from `PREVIOUS_HISTORY.md` by the
release workflow).
→ [Releases](https://git.trevena.info/nick/incido/releases)
· [Previous release history (archive)](./PREVIOUS_HISTORY.md)
---
## License
Incido is released under the **GNU General Public License v3.0**
(GPL-3.0). See [`LICENSE`](./LICENSE) for the full text and
[`NOTICE`](./NOTICE) for attributions.
---
## Project Layout
```
incido/
├── app/ # Android entry point (manifest, MainActivity)
├── composeApp/ # Shared Compose UI module
├── core/
│ ├── domain/ # Pure-Kotlin domain models + repository interface
│ └── data/ # ObjectBox-backed repository implementation
├── gradle/ # Version catalog (libs.versions.toml) + wrapper
├── keystore/ # Release signing (gitignored *.jks, README kept)
├── scripts/ci/ # Release tooling (changelog extractor for the CI)
├── .gitea/ # Gitea Actions workflow + issue/PR templates
├── CONTRIBUTING.md
├── PREVIOUS_HISTORY.md # Archived user-facing release history
└── LICENSE
```
---
## Build Instructions
### Prerequisites
| Tool | Version | Notes |
|------|---------|-------|
| JDK | 17 (LTS) | `java -version` |
| Android SDK | API 35 + build-tools 35.0.0 | Install via `sdkmanager` |
| Gradle | 8.10.2 | Wrapped — `./gradlew` downloads it on first run |
| Kotlin | 2.0.21 | Bundled with the Gradle build |
You do **not** need Android Studio. The CLI build works.
### 1. Configure `local.properties`
Create `local.properties` at the project root (already gitignored):
```
sdk.dir=/path/to/your/Android/sdk
```
On Linux this is typically `~/Android/sdk`.
### 2. Accept SDK licenses (one-time)
```bash
yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses
```
### 3. Build the debug APK
```bash
./gradlew assembleDebug
```
The APK is written to `app/build/outputs/apk/debug/app-debug.apk`.
### 4. (Optional) Build a signed release APK
```bash
./gradlew assembleRelease
```
Uses the dev keystore at `keystore/release.jks` — see
[`keystore/README.md`](./keystore/README.md) for regeneration instructions.
**Replace this keystore with a production key before any external
distribution.**
The build will **fail** if `versionName` doesn't match
`^\d+\.\d+\.\d+\.\d+$` (the new scheme). Update `app/build.gradle.kts`
to fix.
### 5. Install on a device
```bash
adb install -r app/build/outputs/apk/debug/app-debug.apk
```
Or open the project in Android Studio and click **Run**.
---
## Remote / Gitea Setup
When your self-hosted Gitea instance is online, register the remote and
push the existing local commits:
```bash
git remote add origin https://your-gitea.example.com/yourname/incido.git
git push -u origin main
git push origin --tags # if you have any local tags
```
After the first push:
- `.gitea/workflows/build.yml` will automatically build the debug APK
on every push to `main` and on every pull request. The APK is uploaded
as a workflow artefact (`.gitea → Actions → build → Artifacts`).
- `.gitea/ISSUE_TEMPLATE/bug_report.yml` and
`feature_request.yml` will be picked up by Gitea when users open new
issues.
- `.gitea/PULL_REQUEST_TEMPLATE.md` will be auto-loaded on new PRs.
---
## Manual Smoke Test (Development Plan §7.2 + v0.3.0.0 additions)
```
[ ] Launch app — "Incido" title centred, hamburger top-left
[ ] Tap hamburger → drawer slides in with Home / Favorites / Untagged + divider + Recent tags
[ ] Tap "Favorites" → list shows only starred notes
[ ] Tap "Untagged" → list shows only notes with zero hashtags
[ ] Tap a recent hashtag → list filters to that tag
[ ] Tap "Trash" → list shows only soft-deleted notes
[ ] Delete a note → it disappears from Home/search/tag/Favorites and appears in Trash
[ ] Trash card overflow → "Restore" returns the note; "Delete permanently" destroys it
[ ] Tap "Home" → back to all active notes
[ ] Open a note → chip row above text field shows current tags (empty placeholder if none)
[ ] Tap "#" icon → sheet opens, type "wo" → suggestions filter
[ ] Add a new tag → chip appears, counter goes from N/5 to (N+1)/5
[ ] Tap chip ✕ → removed
[ ] Add 5 tags, attempt 6th → Snackbar "Maximum 5 tags reached"
[ ] Force-stop + reopen → all notes + hashtags + favourites + colours persist
```
---
## Architecture (brief)
- **UI**: 100% Jetpack Compose in `composeApp/`. ViewModels expose
immutable `StateFlow<UiState>` per screen; no third-party state
management library.
- **Domain**: Pure Kotlin interfaces in `core/domain/` — the only thing
the UI sees.
- **Data**: `core/data/` provides the ObjectBox implementation. ViewModels
depend on the interface, so the data layer can be swapped (e.g., for
tests) without touching UI code.
## Contributing
See [`CONTRIBUTING.md`](./CONTRIBUTING.md). By submitting a
contribution you affirm you have the right to license it under GPL-3.0.