summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSébastien d'Herbais de Thun <sebastien.d.herbais@gmail.com>2023-04-05 00:58:01 +0200
committerGitHub <noreply@github.com>2023-04-05 00:58:01 +0200
commit205b9f3f2513d15406c47273ca035272db515490 (patch)
treed2fcefa96c9e03185025bf2d582b63d4874d40ef /README.md
parent72c7c04a9d29b818f5fae1d4511593dbe686b557 (diff)
Updated README.md for new CLI (#471)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 33270796..71e55816 100644
--- a/README.md
+++ b/README.md
@@ -123,10 +123,10 @@ the bleeding edge version with `nix run github:typst/typst -- --version`.
Once you have installed Typst, you can use it like this:
```sh
# Creates `file.pdf` in working directory.
-typst file.typ
+typst compile file.typ
# Creates PDF file at the desired path.
-typst path/to/source.typ path/to/output.pdf
+typst compile path/to/source.typ path/to/output.pdf
```
You can also watch source files and automatically recompile on changes. This is
@@ -134,7 +134,16 @@ faster than compiling from scratch each time because Typst has incremental
compilation.
```sh
# Watches source files and recompiles on changes.
-typst --watch file.typ
+typst watch file.typ
+```
+
+You can also add custom font paths for your project and list all of the discovered fonts:
+```sh
+# Adds additional directories to search for fonts.
+typst --font-path path/to/fonts compile file.typ
+
+# Lists all of the discovered fonts.
+typst --font-path path/to/fonts fonts
```
If you prefer an integrated IDE-like experience with autocompletion and instant