offline-labs/gas-stack
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update README
All checks were successful
CI / build-docker (push) Successful in 4s
Details
CI / build-docker-bootstrap (push) Has been skipped
Details
CI / release-test (push) Successful in 19s
Details

Browse Source
This commit is contained in:
~wispem-wantex 2026-02-14 18:33:41 -08:00
parent fd90830340
commit c1150954e5
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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 <path/to/schema.sql>
```
## Run the code generator
#### Code generator
```sh
gas generate table_name # Generates a model