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 17, 2023
1 parent d98f3c5 commit 4ed1e0d
Showing 1 changed file with 64 additions and 1 deletion.
65 changes: 64 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,86 @@
# typst_install
πŸ€– curl | sh installer script for Typst

πŸ€– `curl | sh` installer script for Typst

<table align=center><td>

```sh
# βœ¨πŸš€
curl -fsSL https://typst.community/install_typst/install.sh | sh
typst compile paper.typ
```

</table>

πŸš€ Easy to get started; just one shell command! \
🟦 Works on Windows too

πŸ‘€ Don't want to use `curl | sh`? You can follow the [official Typst
installation instructions] to download a binary from the [typst/typst releases].

## Usage

![Linux](https://img.shields.io/static/v1?style=for-the-badge&message=Linux&color=222222&logo=Linux&logoColor=FCC624&label=)
![Windows](https://img.shields.io/static/v1?style=for-the-badge&message=Windows&color=0078D4&logo=Windows&logoColor=FFFFFF&label=)
![macOS](https://img.shields.io/static/v1?style=for-the-badge&message=macOS&color=000000&logo=macOS&logoColor=FFFFFF&label=)

Linux, macOS, WSL

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

Windows

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

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

Linux, macOS, WSL

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

Windows

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

</details>

<details><summary>Install specific version</summary>

Linux, macOS, WSL

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

Windows

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

</details>

## Development

![sh](https://img.shields.io/static/v1?style=for-the-badge&message=sh&color=4EAA25&logo=GNU+Bash&logoColor=FFFFFF&label=)
![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
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
<!-- prettier-ignore-end -->

0 comments on commit 4ed1e0d

Please sign in to comment.