Update README

This commit is contained in:
Laurenz 2023-09-30 11:23:17 +02:00
parent acb8dcc143
commit 0ed84797e8
2 changed files with 22 additions and 6 deletions

View File

@ -108,14 +108,15 @@ Let's dissect what's going on:
Typst's CLI is available from different sources: Typst's CLI is available from different sources:
- You can get sources and pre-built binaries for the latest release of Typst - You can get sources and pre-built binaries for the latest release of Typst
from the [releases page][releases]. from the [releases page][releases]. Download the archive for your platform and
place it in a directory that is in your `PATH`. To stay up to date with future
releases, you can simply run `typst update`.
- You can install Typst through different package managers. Note that the - You can install Typst through different package managers. Note that the
versions in the package managers might lag behind the latest release. versions in the package managers might lag behind the latest release.
- macOS/Linux: `brew install typst` - Linux: View [Typst on Repology][repology]
- Arch Linux: `pacman -S typst` - macOS: `brew install typst`
- Void Linux: `xbps-install typst` - Windows: `winget install --id Typst.Typst`
- Windows Package Manager: `winget install --id Typst.Typst`
- If you have a [Rust][rust] toolchain installed, you can also install the - If you have a [Rust][rust] toolchain installed, you can also install the
latest development version with latest development version with
@ -163,6 +164,19 @@ If you prefer an integrated IDE-like experience with autocompletion and instant
preview, you can also check out the [Typst web app][app], which is currently in preview, you can also check out the [Typst web app][app], which is currently in
public beta. public beta.
## Community
The main place where the community gathers is our [Discord server][discord].
Feel free to join there to ask questions, help out others, share cool things
you created with Typst, or just to chat.
Aside from that there are a few places where you can find things built by
the community:
- The official [package list](https://typst.app/docs/packages)
- The [Awesome Typst](https://github.com/qjcg/awesome-typst) repository
If you had a bad experience in our community, please [reach out to us][contact].
## Contributing ## Contributing
We would love to see contributions from the community. If you experience bugs, We would love to see contributions from the community. If you experience bugs,
feel free to open an issue. If you would like to implement a new feature or bug feel free to open an issue. If you would like to implement a new feature or bug
@ -224,6 +238,8 @@ instant preview. To achieve these goals, we follow three core design principles:
[scripting]: https://typst.app/docs/reference/scripting/ [scripting]: https://typst.app/docs/reference/scripting/
[rust]: https://rustup.rs/ [rust]: https://rustup.rs/
[releases]: https://github.com/typst/typst/releases/ [releases]: https://github.com/typst/typst/releases/
[repology]: https://repology.org/project/typst/versions
[contact]: https://typst.app/contact
[architecture]: https://github.com/typst/typst/blob/main/docs/dev/architecture.md [architecture]: https://github.com/typst/typst/blob/main/docs/dev/architecture.md
[contributing]: https://github.com/typst/typst/blob/main/CONTRIBUTING.md [contributing]: https://github.com/typst/typst/blob/main/CONTRIBUTING.md
[packages]: https://github.com/typst/packages/ [packages]: https://github.com/typst/packages/

View File

@ -21,7 +21,7 @@ Of course, you are also very welcome to connect with us on social media
[LinkedIn](https://linkedin.com/company/typst), and [LinkedIn](https://linkedin.com/company/typst), and
[GitHub](https://github.com/typst)). [GitHub](https://github.com/typst)).
## What to share? { #want-to-share } ## What to share? { #what-to-share }
For our community, we want to foster versatility and inclusivity. You are For our community, we want to foster versatility and inclusivity. You are
welcome to post about any topic that you think would interest other community welcome to post about any topic that you think would interest other community
members, but if you need a little inspiration, here are a few ideas: members, but if you need a little inspiration, here are a few ideas: