From b3c0d20153a7886b713e1ed8837554ac4ff24de0 Mon Sep 17 00:00:00 2001 From: Pavel Zbitskiy Date: Fri, 6 Dec 2019 11:33:49 -0500 Subject: [PATCH] Documentation update --- GUIDE.md | 2 +- README.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/GUIDE.md b/GUIDE.md index 784da73..5fe95b3 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -1,6 +1,6 @@ # Tealang guide -Tealang translates all (except `mulw`) own constructions to corresponding **TEAL** instructions +Tealang translates all own constructions to corresponding **TEAL** instructions so that there is almost one-to-one mapping between statements in both languages. Refer to [TEAL documentation](https://developer.algorand.org/docs/teal) for details. diff --git a/README.md b/README.md index 6d4e677..d6bbe88 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Teal Language +# Tealang High-level language for Algorand Smart Contracts at Layer-1 and its low-level **TEAL** language. The goal is to abstract the stack-based **TEAL** VM and provide imperative Go/JS/Python-like syntax. @@ -81,10 +81,14 @@ import stdlib.const ```sh tealang -l '(txn.Sender == "abc") && global.MinTxnFee > 2000' -o mycontract.tok ``` -* Stdin to Stdout +* stdin to stdout ```sh cat mycontract.tl | tealang -s -r - > mycontract.tok ``` +* Dryrun / trace + ```sh + tealang -s -c -d '' examples/basic.tl + ``` Checkout [syntax highlighter](https://github.com/pzbitskiy/tealang-syntax-highlighter) for vscode. @@ -107,7 +111,7 @@ Checkout [syntax highlighter](https://github.com/pzbitskiy/tealang-syntax-highli popd ``` -### Build +### Build and test ```sh make go ```