Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcbhmr authored Dec 20, 2023
1 parent 37785ad commit 7b5edd0
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# typst_install
# Typst installer

🤖 `curl | sh` installer script for Typst
🤖 `curl | sh` installer script for Typst \
💡 Inspired by [denoland/deno_install]

<table align=center><td>

```sh
# ✨🚀
curl -fsSL https://typst.community/typst_install/install.sh | sh
curl -fsSL https://typst.community/typst-install/install.sh | sh
typst compile paper.typ
```

Expand All @@ -27,29 +28,29 @@ instructions] and download a binary from [typst/typst releases].
Linux, macOS, WSL

```sh
curl -fsSL https://typst.community/typst_install/install.sh | sh
curl -fsSL https://typst.community/typst-install/install.sh | sh
```

Windows

```ps1
irm https://typst.community/typst_install/install.ps1 | iex
irm https://typst.community/typst-install/install.ps1 | iex
```

<details><summary>Change install location</summary>

Linux, macOS, WSL

```sh
export TYPST_INSTALL="/usr/local"
curl -fsSL https://typst.community/typst_install/install.sh | sh
export typst-install="/usr/local"
curl -fsSL https://typst.community/typst-install/install.sh | sh
```

Windows

```ps1
$Env:TypstInstall = "C:\Program Files\typst"
irm https://typst.community/typst_install/install.ps1 | iex
irm https://typst.community/typst-install/install.ps1 | iex
```

</details>
Expand All @@ -59,13 +60,13 @@ irm https://typst.community/typst_install/install.ps1 | iex
Linux, macOS, WSL

```sh
curl -fsSL https://typst.community/typst_install/install.sh | sh -s 0.10.0
curl -fsSL https://typst.community/typst-install/install.sh | sh -s 0.10.0
```

Windows

```ps1
v="0.10.0"; irm https://typst.community/typst_install/install.ps1 | iex
v="0.10.0"; irm https://typst.community/typst-install/install.ps1 | iex
```

</details>
Expand Down Expand Up @@ -98,11 +99,12 @@ Options:
![PowerShell](https://img.shields.io/static/v1?style=for-the-badge&message=PowerShell&color=5391FE&logo=PowerShell&logoColor=FFFFFF&label=)

GitHub Pages is enabled and pulls straight from the `main` branch's root folder.
That's how the `https://typst.community/typst_install/install.sh` script is
That's how the `https://typst.community/typst-install/install.sh` script is
published. That means it's a good idea to **make sure that the `main` branch
always works!** 😉

<!-- prettier-ignore-start -->
[official Typst installation instructions]: https://github.com/typst/typst#installation
[typst/typst releases]: https://github.com/typst/typst/releases
[denoland/deno_install]: https://github.com/denoland/deno_install
<!-- prettier-ignore-end -->

0 comments on commit 7b5edd0

Please sign in to comment.