From 25fa49ffe2cd89a71b0d50fcd58c35d519273767 Mon Sep 17 00:00:00 2001 From: Sudo-Ivan Date: Sun, 28 Dec 2025 22:20:15 -0600 Subject: [PATCH] Update README --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a26ba57..5c1ff8a 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,46 @@ A Go implementation of the [Reticulum Network Stack](https://github.com/markqvis ## Goals - To be fully compatible with the original Python implementation. -- Additional privacy and security features. - Support for a broader range of platforms and architectures legacy and modern. +- Additional privacy and security features. -## Quick Start +## Development ### Prerequisites - Go 1.24 or later +- [go-task](https://taskfile.dev/) + +Might need `alias task='go-task'` in your shell to use it as `task` instead of `go-task`. ### Build ```bash -make build +task build ``` ### Run ```bash -make run +task run ``` ### Test ```bash -make test +task test +``` + +### Format Code + +```bash +task fmt +``` + +### Run All Checks + +```bash +task check ``` ## Embedded systems and WebAssembly @@ -39,8 +54,8 @@ For building for WebAssembly and embedded systems, see the [tinygo branch](https Note: I am not actively working on webassembly support at the moment. ```bash -make tinygo-build -make tinygo-wasm +task tinygo-build +task tinygo-wasm ``` ### Experimental Features @@ -48,7 +63,7 @@ make tinygo-wasm Build with experimental Green Tea GC (Go 1.25+): ```bash -make build-experimental +task build-experimental ``` ## License