Add RIPPR.md explaining the source snapshot and history bundle
Lives at the repo root rather than inside rippr-src/, because refreshing the snapshot deletes and re-exports that directory wholesale - which already ate an earlier copy of this note. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
54
RIPPR.md
Normal file
54
RIPPR.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Rippr — copies held here
|
||||
|
||||
Rippr is a native Android GPS ride recorder for motorcycles. Its canonical repo is
|
||||
`~/dojo/rippr`, which **has no git remote** — it exists only on that machine, so the
|
||||
bundle below is the only off-machine copy of its history.
|
||||
|
||||
**Snapshot taken at:** `46a0726` — "Document the whole project: README, architecture, v1 history, v3 backlog" (19 commits)
|
||||
|
||||
## What is here
|
||||
|
||||
| File | Purpose |
|
||||
|---|---|
|
||||
| `rippr-src/` | Browsable source, exported with `git archive HEAD`. No history; will drift. |
|
||||
| `rippr-full-history.bundle` | Full git history. The actual backup. |
|
||||
| `rippr-2.0.1-debug.apk` | Latest installable build (debug-signed) |
|
||||
| `rippr-2.0-debug.apk`, `rippr-1.0-debug.apk` | Previous builds |
|
||||
|
||||
`rippr-src/` contains tracked files only — no build outputs, no `local.properties`, no
|
||||
nested `.git`.
|
||||
|
||||
## Restoring the full repo
|
||||
|
||||
```bash
|
||||
git clone rippr-full-history.bundle rippr
|
||||
cd rippr
|
||||
echo "sdk.dir=$HOME/Library/Android/sdk" > local.properties
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
|
||||
Needs **JDK 17–21** — AGP does not support 25 — and the Android SDK with platform 35 and
|
||||
build-tools 35.
|
||||
|
||||
## Where to start reading
|
||||
|
||||
Inside `rippr-src/`:
|
||||
|
||||
- `README.md` — what the app is and its current state
|
||||
- `docs/ARCHITECTURE.md` — the design decisions and why
|
||||
- `docs/v3/BACKLOG.md` — known gaps, deferred work, what must not regress
|
||||
- `docs/TESTING.md` — especially "What the emulator cannot verify"
|
||||
- `docs/v2/PROGRESS.md` — every bug found during v2 development
|
||||
|
||||
## Keeping these current
|
||||
|
||||
```bash
|
||||
cd ~/dojo/samplez
|
||||
rm -rf rippr-src && mkdir rippr-src
|
||||
git -C ~/dojo/rippr archive HEAD | tar -x -C rippr-src
|
||||
(cd ~/dojo/rippr && git bundle create /tmp/rb.bundle --all) && mv /tmp/rb.bundle rippr-full-history.bundle
|
||||
git bundle verify rippr-full-history.bundle
|
||||
```
|
||||
|
||||
Note the export wipes `rippr-src/` wholesale, which is why this file lives at the repo
|
||||
root rather than inside it.
|
||||
Reference in New Issue
Block a user