From 5d4fde2551fb73e84cdc5fb1cd9f5f51c0cd4d67 Mon Sep 17 00:00:00 2001 From: burinc Date: Mon, 7 Sep 2026 13:19:31 +1000 Subject: [PATCH] docs: mark the port as work in progress, drop the placeholder gallery A Reddit comment on the Jolt Android/iOS announcement pointed out the README's image gallery reads as Android screenshots at a glance, even with the one-line caption underneath. They are raylib-ios captures of the same scene files, and this port has not been run on Android hardware yet (the RUNBOOK already says so at the top), so the gallery was showing something not yet confirmed. - Drop the embedded gallery (20 images) from the README entirely rather than re-captioning it again. A link to raylib-ios's own README stands in for it until this build has real Android captures to show. - Add an explicit work-in-progress line up front, matching the RUNBOOK's own wording, so the caveat isn't something a reader only finds by reaching the small print under a wall of screenshots. - Soften "What runs today" to "What exists today" and note which part of that is host-tested (`jolt test`) versus written-but-unconfirmed-on-device behaviour (tap/back/flap), instead of stating both in the same present tense. - Fix the Attribution section's "the captures above" line, which pointed at the gallery just removed. No image assets deleted -- only what the README shows. docs/templates/home.html still renders the same gallery on the project site; that's a separate surface this pass didn't touch. --- README.md | 60 ++++++++++++++++++------------------------------------- 1 file changed, 19 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 36a36c3..105b0ba 100644 --- a/README.md +++ b/README.md @@ -4,45 +4,23 @@ raylib on an Android phone, driven from Clojure by [jolt](https://github.com/jolt-lang/jolt), as native arm64 code with no JVM, no Kotlin and no Java anywhere in the app. -What runs today: a gallery of seventeen scenes in four categories, each one a -pure `.cljc` simulation, under an Android owner loop of about thirty lines. -Tap a card to open a scene; Back walks one level up and quits from the top. The -bird flaps on a press edge. - -

- The category screen - Spirograph - Penrose P3 tiling - Kaleidoscope -

-

- Boids - Fireworks - Flappy Bird -

- -

- Spirograph drawing itself - Kaleidoscope - Fireworks - Boids flocking - Flappy Bird, flapped over the nREPL -

-

- A chaotic double pendulum - Fourier epicycles drawing a square wave - A fractal tree swaying - A starfield - An L-system plant growing - Particles in a flow field -

-

- The Lorenz attractor, camera orbiting - A rotating 4D hypercube -

- -*Captured off the sibling build this was ported from, since the host here has -not met a device yet. The scenes are the same files.* +**Work in progress: this has not yet been run on Android hardware.** The +RUNBOOK says the same thing at the top, for the same reason: what follows +below is read off the pinned raylib source and the code in this tree, not +measured on a phone. + +What exists today: a gallery of seventeen scenes in four categories, each one +a pure `.cljc` simulation, under an Android owner loop of about thirty lines. +The scene contract is tested on the build host (`jolt test`, no device +needed). Tap-to-open, Back walking one level up, the bird flapping on a press +edge: the code is written to do all of that, and none of it has a phone +behind it yet. + +There are no screenshots here yet, for the same reason: nothing has run on +Android to photograph honestly. The scenes are the same pure `.cljc` files as +[raylib-ios](https://github.com/jlt-commons/raylib-ios), the sibling project +this tree was ported from. That README has captures of what they draw, and +this section gets real Android ones once this build has actually met a phone. Licensed [zlib](LICENSE), matching raylib and [raylib-jlt](https://github.com/jlt-commons/raylib-jlt). Third-party code and @@ -403,8 +381,8 @@ for one is pending, so the zlib licence above does not cover those parts. - [statonjr/glimmer-ios-demo](https://github.com/statonjr/glimmer-ios-demo): the owner loop's shape, the scene ports and most of the traps. - [jlt-commons/raylib-ios](https://github.com/jlt-commons/raylib-ios): the - seventeen scenes, the `GetFPS` finding, the performance guide and the - captures above. + seventeen scenes, the `GetFPS` finding, the performance guide and the only + captures anyone has taken of them so far. - [raylib](https://github.com/raysan5/raylib) at `9f3cadf1e618f125bd9b282c7759f8cb26ce17fc`, which calls itself `6.1-dev`. Pinned by revision rather than by tag because the host's comments cite