Skip to content

Commit 09ad663

Browse files
committed
docs: show pre-releases in the release badge, list the new gates
Every release is now published as a pre-release until it has been flashed to a real calculator, and shields.io's github/v/release excludes pre-releases by default -- the badge read "no releases or repo not found". Add include_prereleases. docs/index.html needs no change: /releases/latest redirects to the releases list while no stable release exists, and points straight at one after promotion. Also surface verify-install / check-budgets / sim-test in the README, and say why a green `make` does not mean the app is installable.
1 parent 33a4524 commit 09ad663

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# RPN for NumWorks
66

7-
[![GitHub release](https://img.shields.io/github/v/release/1e1/numworks-RPN?style=flat-square)](https://github.com/1e1/numworks-RPN/releases)
7+
[![GitHub release](https://img.shields.io/github/v/release/1e1/numworks-RPN?include_prereleases&style=flat-square)](https://github.com/1e1/numworks-RPN/releases)
88
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/1e1/numworks-RPN?style=flat-square&color=brightgreen)](https://github.com/1e1/numworks-RPN/commits/main)
99
[![License](https://img.shields.io/github/license/1e1/numworks-RPN?style=flat-square)](https://github.com/1e1/numworks-RPN/blob/main/LICENSE)
1010

@@ -105,15 +105,23 @@ Lower-frequency operations, navigated with `↑`/`↓` and `OK`, closed with
105105
Requires `arm-none-eabi-gcc` and Node.js (for [`nwlink`](https://www.npmjs.com/package/nwlink)).
106106

107107
```shell
108-
make # build output/rpn.nwa
109-
make install # build and upload to a plugged-in calculator
110-
make test # build and run the host-side engine unit tests
108+
make # build output/rpn.nwa
109+
make install # build and upload to a plugged-in calculator
110+
make test # host-side engine unit tests
111+
make verify-install # perform the install-time link, no calculator needed
112+
make check-budgets # assert the RAM and 32 KiB-stack budgets
113+
make sim-test # replay tests/sim in the Epsilon simulator (Docker)
111114
```
112115

113116
The numeric core (`src/value`, `src/stack`, `src/rpn`, `src/input_field`) is pure
114117
C++ with no calculator dependency, so `make test` compiles and runs it on your
115118
host machine.
116119

120+
`make` only produces a *relocatable* object, so it cannot fail on undefined
121+
symbols — the link that decides whether a calculator can install the app happens
122+
later, and `verify-install` is what rehearses it. See
123+
[CONTRIBUTING.md](CONTRIBUTING.md#verifying-a-change) for which check catches what.
124+
117125
## Try it in a web simulator (Docker)
118126

119127
Run the app in a browser via the Epsilon web simulator — only Docker is needed

0 commit comments

Comments
 (0)