mirror of
https://github.com/ralsina/tartrazine.git
synced 2024-11-10 05:22:23 +00:00
Merge pull request #1 from ralgozino/docs/improve-v0.6.0-instructions
docs: improve readme and help message
This commit is contained in:
commit
cd7e150aae
10
README.md
10
README.md
@ -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
|
||||
|
@ -20,7 +20,8 @@ Usage:
|
||||
Options:
|
||||
-f <formatter> Format to use (html, terminal, json)
|
||||
-t <theme> Theme to use, see --list-themes [default: default-dark]
|
||||
-l <lexer> Lexer (language) to use, see --list-lexers [default: autodetect]
|
||||
-l <lexer> Lexer (language) to use, see --list-lexers. Use more than
|
||||
one lexer with "+" (e.g. jinja+yaml) [default: autodetect]
|
||||
-o <output> Output file. Default is stdout.
|
||||
--standalone Generate a standalone HTML file, which includes
|
||||
all style information. If not given, it will generate just
|
||||
|
Loading…
Reference in New Issue
Block a user