From c1150954e5874ed4a64c1398db1fad392400bfe2 Mon Sep 17 00:00:00 2001 From: ~wispem-wantex Date: Sat, 14 Feb 2026 18:33:41 -0800 Subject: [PATCH] doc: update README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ae3e0e..d1dc5fd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # GAS stack + + ## Compiling Requires a Go compiler (minimum 1.22.5) and a C compiler, due to use of CGo. @@ -14,13 +16,20 @@ sudo mv gas /usr/local/bin # ...or anywhere on your $PATH which gas # should print "/usr/local/bin/gas" ``` -## Run the linter +## Using + +The linter (`gas sqlite_lint`) is stable and useful. + +The code generator is buggy, incomplete, and not remotely stable, but still quite useful. Don't expect it to produce perfectly working code, or even to compile correctly (e.g., you'll probably have to fix the imports). Copy-paste the parts that are useful, and delete the parts that aren't. + + +#### Linter ```sh gas sqlite_lint ``` -## Run the code generator +#### Code generator ```sh gas generate table_name # Generates a model