From c1b694ab2749d78016748bfd1ce5b601d1c75c78 Mon Sep 17 00:00:00 2001 From: Chris Gianelloni Date: Thu, 12 Dec 2024 16:36:35 -0500 Subject: [PATCH] docs(readme): dev/build section (#274) Signed-off-by: Chris Gianelloni --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 689dc3d..104cef6 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,18 @@ This is a work in progress and is currently under heavy development dingo screenshot +## Development / Building + +This requires Go 1.22 or better is installed. You also need `make`. + +```bash +# Build +make +# Run +./dingo +``` + +You can also run the code without building a binary, first +```bash +go run ./cmd/dingo/ +```