Dadido3/go-typst
1
0
Fork 0
mirror of https://github.com/Dadido3/go-typst.git synced 2025-04-11 12:13:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
David Vogel 2024-12-20 21:25:44 +01:00
parent 5cd261c199
commit 40b899ee67
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -31,6 +31,17 @@ The supported and tested versions right now are:
You need to have [typst] installed on any machine that you want to run your go project on.
You can install it by following [the instructions in the typst repository].
Alternatively you can pack the typst executable with your application. In this case you have to set up the CLI object similar to this:
```go
typstCLI := typst.CLI{
ExecutablePath: "./typst",
}
```
> [!NOTE]
> Make sure to follow the typst license requirements when you pack and distribute the typst executable with your software.
## Usage
Here we will create a simple PDF document by passing a reader with typst markup into `typstCLI.Compile` and then let it write the resulting PDF data into a file: