afonso/toke
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added install instructions

Browse source
This commit is contained in:
Afonso Franco 2024-02-25 13:37:51 +00:00
parent 22ecfb98d9
commit 90cd9826b7
Signed by: afonso
SSH key fingerprint: SHA256:JiuxZNdA5bRWXPMUJChI0AQ75yC+cXY4xM0IaVwEVys
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -3,6 +3,24 @@
Toke (TOML Make) is a simple command runner inspired by Make but uses TOML (Tom's Obvious, Minimal Language) instead of Makefiles.
This project was created for fun as an alternative to Make, because I was looking for a simple command runner/build system but didn't like the Makefile syntax.
# Installing toke
You can get toke from crates.io:
```sh
cargo install toke-runner
```
You can also manually compile it with cargo:
```sh
git clone https://git.olympuslab.net/afonso/toke
cd toke
cargo build --release
```
The executable should then be in `target/release/toke`
# How to use toke
Toke works by reading a TOML file named `tokefile.toml` (or any variation of it like `Tokefile.toml`, `tokefile`, etc.) in your project directory. This file contains definitions of variables, targets, and their respective commands.