From 09dec30335fc66235bf53b6c054684c021b250fe Mon Sep 17 00:00:00 2001 From: kruemelmann Date: Sat, 25 Nov 2023 05:39:30 +0100 Subject: [PATCH] update Readme --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa87bd5..5279e3b 100644 --- a/README.md +++ b/README.md @@ -27,23 +27,33 @@ sudo curl -L "https://github.com/kruemelmann/komodo/releases/download/v0.1.18/ko ## Usage -### Simply build pdf from LaTex File +### Build command + +#### Simply build pdf from LaTex File ```bash komodo build -f .tex ``` -### Build pdf from LaTex with a watcher +#### Build pdf from LaTex with a watcher (You dont need to run the script everytime you change the tex-File) ```bash komodo build -w -f .tex ``` -### Build pdf (with watcher) and serve it to your browser +### Serve command + +#### Build pdf (with watcher) and serve it to your browser (The ui has hot reload of course otherwise the watcher in the backend would be useless) ```bash komodo serve -f .tex ``` +#### Serve on a different port +The default port of komodo is 9090 but if you want to start it on a different port you can simply do this with the port flag. +```bash +komodo serve -p 8081 -f .tex +``` + ## 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.