talc/README.md

27 lines
610 B
Markdown
Raw Normal View History

2024-12-25 12:53:56 -05:00
# Talc
2024-03-30 12:21:09 -04:00
2024-12-25 12:53:56 -05:00
Talc is a dynamically-typed functional programming language designed primarily
for use as a terminal calculator.
2024-03-30 12:21:09 -04:00
2024-12-25 12:53:56 -05:00
## Installation
Talc is written in Rust and requires at least version 1.81 to compile.
```bash
2024-11-14 14:16:33 -05:00
cargo install --profile release-opt --path talc-bin
2024-03-30 12:21:09 -04:00
```
2024-12-25 12:53:56 -05:00
Read the documentation for more info.
## Documentation
2025-01-06 13:48:15 -05:00
Documentation is available online at [https://talc.trimill.xyz/docs/](https://talc.trimill.xyz/docs/).
2024-12-25 12:53:56 -05:00
To build the documentation locally, install
[mdBook](https://rust-lang.github.io/mdBook/) and run the following from the
`docs/` directory:
```bash
mdbook serve --open
```