From b9ea93351a909eb5574de0e8d81f73456f9bd93a Mon Sep 17 00:00:00 2001 From: Travis Shears Date: Sat, 13 Jul 2024 14:55:56 +0200 Subject: [PATCH] Update docs --- .vscode/spellright.dict | 1 + README.md | 47 ++++++++++++++++++++++++++++++++++++++--- 2 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 .vscode/spellright.dict diff --git a/.vscode/spellright.dict b/.vscode/spellright.dict new file mode 100644 index 0000000..ed9a1c6 --- /dev/null +++ b/.vscode/spellright.dict @@ -0,0 +1 @@ +tal diff --git a/README.md b/README.md index 3f17a09..97def41 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,55 @@ -These are my UXN experiments +These are my UXN experiments. + + +## 99 Bottles of beer + +File: [99_bottles.tal](https://git.sr.ht/~travisshears/uxn-notebook/tree/main/item/99_bottles.tal) + +This is my first tal script. I was inspired by an example in the kitten (another +forth based programming language) repo. It prints the lyrics to the song going from "99 bottles of beer on the wall" to none. + +Sample output: + +``` +18 bottles of beer on the wall +18 bottles of beer +take one down, pass it around + +17 bottles of beer on the wall +17 bottles of beer +take one down, pass it around + +16 bottles of beer on the wall +16 bottles of beer +take one down, pass it around +``` + +Sources: + +- [wiki ref](https://en.wikipedia.org/wiki/99_Bottles_of_Beer) +- [kitten example](https://github.com/evincarofautumn/kitten/blob/129d4bc7e5658a03cc765358ba0a1aba2dbf1c73/examples/beer.ktn) # Dev -## Edit file +## Compile a tal file to a rom and run it via cli + +```shell +./run.sh 99_bottles.tal +``` + +## Auto compile and run + +```shell +$ echo 99_bottles.tal | entr ./run.sh +``` + +## Edit file using the left editor ```shell $ ../uxn/bin/uxnemu ../left.rom 99_bottles.tal ``` -## Step through debugger +## Step through debugging with beetbug ```shell $ echo 99_bottles.rom | entr -r ../uxn/bin/uxnemu ../beetbug.rom ./99_bottles.rom