docs: improve readme and help message

- Add example for printing output to the terminal
- Fix example for usage as CLI tool (missing -f flag)
- Add instructions in the help message for combining lexers
This commit is contained in:
Ramiro Algozino
2024-08-23 18:30:14 +02:00
parent d8ddf5d8b6
commit 176b8e9bc9
2 changed files with 11 additions and 2 deletions

View File

@ -49,9 +49,17 @@ To build from source:
## Usage as a CLI tool
Show a syntax highlighted version of a C source file in your terminal:
```shell
$ tartrazine whatever.c -l c -t catppuccin-macchiato --line-numbers -f terminal
```
Generate a standalone HTML file from a C source file with the syntax highlited:
```shell
$ tartrazine whatever.c -l c -t catppuccin-macchiato --line-numbers \
--standalone -o whatever.html
--standalone -f html -o whatever.html
```
## Usage as a Library