From 205b9f3f2513d15406c47273ca035272db515490 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20d=27Herbais=20de=20Thun?= Date: Wed, 5 Apr 2023 00:58:01 +0200 Subject: [PATCH] Updated README.md for new CLI (#471) --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 332707960..71e558166 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