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-18 20:32:14 +01:00
parent 406fa5dafa
commit 042f1920c9
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,11 +1,27 @@
# go-typst
A library to generate documents via [typst].
A library to generate documents and reports by utilizing the command line version of [typst].
Features include:
- Encoder to convert go objects into typst objects which then can be injected into typst documents.
- Parsing of returned errors into go error objects.
- Uses stdio; No temporary files need to be created.
- Test coverage of most features.
## Installation
1. Use `go get github.com/Dadido3/go-typst` inside of your module to add this library to your project.
2. Install typst by following [the instructions in the typst repository].
## Runtime requirements
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].
## Usage
ToDo
[the instructions in the typst repository]: https://github.com/typst/typst?tab=readme-ov-file#installation
[typst]: https://typst.app/