From 297c7b96cbcbfc0b6ba79a24f72e9bbd46e3a177 Mon Sep 17 00:00:00 2001 From: kruemelmann Date: Sat, 25 Nov 2023 06:05:18 +0100 Subject: [PATCH] update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 22cd820..b4122cc 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,20 @@ If you like to run komodo on a random free port you can add the random_port flag komodo serve --random_port -f .tex ``` +### Getting help +To print the Helppage of komodo just run its basecommand: +```bash +komodo +``` +Or add the -h flag: +```bash +komodo -h +``` +If you need help with a subcommand like serve or build just run: +```bash +komodo -h +``` + ## Supported platforms At the moment I only support x86 or ARM based Mac or x86 Linux in komodo but if you want to use another platform and can't build komodo from source you can open an issue and I will integrate a build for your preferred platform in the CI pipeline.