From 41d3462f098d4a7d26b9c19420a137cfd92ba90b Mon Sep 17 00:00:00 2001 From: ozzy <2+ozzy@noreply.localhost> Date: Sun, 27 Sep 2026 15:29:01 -0500 Subject: [PATCH] docs(readme): update readme added installation, building, and contribution details to the readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9e6e67f..197b6db 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,18 @@ $ mcl ``` for full usage, see `mcl -h` + +## installation +install using cargo. +```sh +cargo install --git https://git.ozzy.top/ozzy/mcl +``` + +## building +build using `just`. see available recipes by running `just` or `just --list`. + +## contribution +before contributing, make sure all tests pass. also make sure to add tests for any new features. +```sh +just test +```