Tiny README update
This commit is contained in:
32
README.md
32
README.md
@@ -2,12 +2,14 @@
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
tricu (pronounced "tree-shoe") is a programming language experiment in Haskell. It is fundamentally based on the application of [Triage Calculus](https://olydis.medium.com/a-visual-introduction-to-tree-calculus-2f4a34ceffc2), an extended form of [Tree Calculus](https://github.com/barry-jay-personal/typed_tree_calculus/blob/main/typed_program_analysis.pdf), terms, but minimal syntax sugar is included.
|
tricu (pronounced "tree-shoe") is a programming language experiment in Haskell. It is fundamentally based on the application of [Triage Calculus](https://olydis.medium.com/a-visual-introduction-to-tree-calculus-2f4a34ceffc2), an extended form of [Tree Calculus](https://github.com/barry-jay-personal/typed_tree_calculus/blob/main/typed_program_analysis.pdf), but minimal syntax sugar is included.
|
||||||
|
|
||||||
tricu is the word for "tree" in Lojban: `(x1) is a tree of species/cultivar (x2)`.
|
tricu is the word for "tree" in Lojban: `(x1) is a tree of species/cultivar (x2)`.
|
||||||
|
|
||||||
I have fully embraced the slopmachine (LLM-assisted development) for this project. Nothing is stable or sacred. We will discover sanity at the end of the journey but we won't strive for it until then.
|
I have fully embraced the slopmachine (LLM-assisted development) for this project. Nothing is stable or sacred. We will discover sanity at the end of the journey but we won't strive for it until then.
|
||||||
|
|
||||||
|
This README.md is human written. No other .md file will be until stabilization.
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
Tree Calculus was discovered by [Barry Jay](https://github.com/barry-jay-personal/blog). The addition of Triage rules were suggested by [Johannes Bader](https://johannes-bader.com/). Johannes is also the creator of [treecalcul.us](https://treecalcul.us) which has a great intuitive code playground using his language LambAda.
|
Tree Calculus was discovered by [Barry Jay](https://github.com/barry-jay-personal/blog). The addition of Triage rules were suggested by [Johannes Bader](https://johannes-bader.com/). Johannes is also the creator of [treecalcul.us](https://treecalcul.us) which has a great intuitive code playground using his language LambAda.
|
||||||
@@ -62,30 +64,6 @@ You can easily build and run this project using [Nix](https://nixos.org/download
|
|||||||
|
|
||||||
`./result/bin/tricu --help`
|
`./result/bin/tricu --help`
|
||||||
|
|
||||||
```
|
## Usage
|
||||||
tricu Evaluator and REPL
|
|
||||||
|
|
||||||
tricu [COMMAND] ... [OPTIONS]
|
I'll update this once the CLI stabilizes more.
|
||||||
tricu: Exploring Tree Calculus
|
|
||||||
|
|
||||||
Common flags:
|
|
||||||
-? --help Display help message
|
|
||||||
-V --version Print version information
|
|
||||||
|
|
||||||
tricu [repl] [OPTIONS]
|
|
||||||
Start interactive REPL
|
|
||||||
|
|
||||||
tricu eval [OPTIONS]
|
|
||||||
Evaluate tricu and return the result of the final expression.
|
|
||||||
|
|
||||||
-f --file=FILE Input file path(s) for evaluation.
|
|
||||||
Defaults to stdin.
|
|
||||||
-t --form=FORM Optional output form: (tree|fsl|ast|ternary|ascii|decode).
|
|
||||||
Defaults to tricu-compatible `t` tree form.
|
|
||||||
|
|
||||||
tricu decode [OPTIONS]
|
|
||||||
Decode a Tree Calculus value into a string representation.
|
|
||||||
|
|
||||||
-f --file=FILE Optional input file path to attempt decoding.
|
|
||||||
Defaults to stdin.
|
|
||||||
```
|
|
||||||
|
|||||||
Reference in New Issue
Block a user