docs: add the Plan 9 assembly case and real-use note to the README

2026-09-19 18:06:18 +02:00
parent c834d98210
commit 96e81cc98d
2 changed files with 101 additions and 14 deletions
@@ -40,6 +40,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  states the commit trailer form, the one-logical-change rule and the
  licence header rule.  The repository's own assembly (the `verify`
  trampolines and the test kernels) is in `gasm fmt` canonical form.
+- **The README states the project's purpose and status.**  It opens with
+  a warning that the tool is an experiment under active development,
+  version 0.x.x, free to change without warning, with 1.0.0 far off,
+  and already in active use on real assembly work.  It describes both
+  goals (tooling for Plan 9 assembly, and Plan 9 assembly outside the
+  Go toolchain), argues the case for the syntax in a new Why Plan 9
+  assembly section, and carries a Direction section: extended
+  instruction support, full GOOBJ and ELF compilation, Linux and
+  FreeBSD, and the four architectures.

 ### Fixed