From a73673d5483edf0e320cf88dc4884f1488187af3 Mon Sep 17 00:00:00 2001
From: tinger <me@tinger.dev>
Date: Tue, 23 Jul 2024 17:52:55 +0200
Subject: [PATCH] docs(book): Add installation chapter

Adds an installation chapter to the quick start part of the book, this section
outlines methods of installation, as well as system dependencies such as
openssl.
---
 docs/book/src/SUMMARY.md            |  2 +-
 docs/book/src/quickstart/install.md | 28 ++++++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 docs/book/src/quickstart/install.md

diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
index 17e4b70..5d54260 100644
--- a/docs/book/src/SUMMARY.md
+++ b/docs/book/src/SUMMARY.md
@@ -2,7 +2,7 @@
 [Introduction](./README.md)
 
 # Quickstart
-- [Installation]()
+- [Installation](./quickstart/install.md)
 - [Usage]()
 - [Concepts]()
 - [Configuration]()
diff --git a/docs/book/src/quickstart/install.md b/docs/book/src/quickstart/install.md
new file mode 100644
index 0000000..3be1d17
--- /dev/null
+++ b/docs/book/src/quickstart/install.md
@@ -0,0 +1,28 @@
+# Installation
+To install `typst-test` on your PC, you must, for the time being, compile it from source.
+Once `typst-test` reaches 0.1.0 this restruction will be lifted and each release will provide precompiled binaries for major operating systems.
+
+## Installation From Source
+To install `typst-test` from source you must have a Rust toolchain (Rust **v1.80.0+**) and cargo installed.
+
+Run the following command to install the latest nightly version
+```bash
+cargo install --locked --git https://github.com/tingerrr/typst-test
+```
+
+To install the latest semi stable version run
+```bash
+cargo install --locked --git https://github.com/tingerrr/typst-test --tag ci-semi-stable
+```
+
+## Required Libraries
+### Openssl
+Openssl (**v???**) is required to allow `typst-test` to download packages from the [Typst Universe](https://typst.app/universe) package registry.
+
+When installing from source the `vendor-openssl` feature can be used on operating systems other than Windows and macOS to statically vendor and statically link to openssl, avoiding the need for it on the operating system.
+
+<div class="warning">
+
+This is not yet possible, but will be once [#32](https://github.com/tingerrr/typst-test/issues/32) is resolved, in the meantime openssl may be linked ot dynamically as a transitive dependency.
+
+<div>