From b4055eaa9d526a71e27af7e8774578d526e859ed Mon Sep 17 00:00:00 2001 From: David Keane Date: Thu, 11 Jul 2024 02:25:11 +0100 Subject: [PATCH] Added instructions to run the script --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6ec31c..3bf89ec 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,11 @@ In this example, we used the [Ebitengine](https://ebitengine.org), an incredibly Note that some operating systems may restrict the execution of binaries downloaded from the internet for security reasons. Please consult your operating system documentation to learn how to enable Neko to run. -## Parameters +$ cd neko + +$ go run ./main.go + +Parameters - `-mousepassthrough` Enable mouse passthrough (default false). - `-quiet` Disable sound. @@ -24,8 +28,6 @@ Note that some operating systems may restrict the execution of binaries download - `-speed` The speed of the cat (default 2). - `-h` Show help. - ## How to Contribute - Please follow our [contribution guide](CONTRIBUTING.md).