From d4069a01f32dd6096538600d5a0d64c76c2cd6ff Mon Sep 17 00:00:00 2001 From: Pyro57000 <147988717+Pyro57000@users.noreply.github.com> Date: Thu, 25 Sep 2025 15:50:45 -0500 Subject: [PATCH] Update README.md added the actual readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bdfa73..d6cfae5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ # tetanus_shares sharp sharesish but in rust! -I've just started on this, so it doesn't quite work yet, but I think I'm close. +# Usage: +tetanus_shares -o C:\path\to\save -t threadcount + +If no arugments are givin it proceedes with the defaults of no save file, and 10 threads. + +# Building +`git clone https://github.com/Pyro57000/tetanus_shares.git` + +`cd tetanus_shares` + +`cargo build --target x86_64-pc-windows-gnu --release` + +Then your exe will be in the target/x86_64-pc-windows-gnu/release directory! + +or you can just download the exe from the releases here.