Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kruemelmann committed Nov 25, 2023
1 parent d42cd52 commit 09dec30
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <filename>.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 <filename>.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 <filename>.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 <filename>.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.
Expand Down

0 comments on commit 09dec30

Please sign in to comment.