From aa50a7734f2d896d27bd7a31e6ffef34dc54fdc1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89milien=20Devos?= <contact@emiliendevos.be>
Date: Fri, 29 Jul 2022 09:40:35 +0000
Subject: [PATCH] Add note about lsquic and add guide for windows

---
 docs/installation.md | 41 ++++++++++++++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 7 deletions(-)

diff --git a/docs/installation.md b/docs/installation.md
index b53619c..04462af 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -165,6 +165,12 @@ crystal build src/invidious.cr --release
 exit
 ```
 
+Note: If the command `crystal build` didn't work properly, you can build Invidious without lsquic may solve compatibilities issues:
+
+```bash
+crystal build src/invidious.cr -Ddisable_quic --release
+```
+
 #### Systemd service
 
 ```bash
@@ -174,14 +180,16 @@ systemctl enable --now invidious.service
 
 ### MacOS
 
+#### Install the dependencies
+
 ```bash
-# Install dependencies
 brew update
 brew install shards crystal postgres imagemagick librsvg
+```
 
-# Clone the repository and set up a PostgreSQL database
-git clone https://github.com/iv-org/invidious
-cd invidious
+#### Set up PostgresSQL
+
+```bash
 brew services start postgresql
 psql -c "CREATE ROLE kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
 createdb -O kemal invidious
@@ -195,11 +203,30 @@ psql invidious kemal < config/sql/annotations.sql
 psql invidious kemal < config/sql/privacy.sql
 psql invidious kemal < config/sql/playlists.sql
 psql invidious kemal < config/sql/playlist_videos.sql
-
-# Set up Invidious
-shards update && shards install && crystal build src/invidious.cr --release
 ```
 
+#### Set up Invidious
+
+```bash
+git clone https://github.com/iv-org/invidious
+cd invidious
+shards install --production
+crystal build src/invidious.cr --release
+```
+
+Note: If the command `crystal build` didn't work properly, you can build Invidious without lsquic may solve compatibilities issues:
+
+```bash
+crystal build src/invidious.cr -Ddisable_quic --release
+```
+
+### Windows
+
+Crystal, the programming language used by Invidious, [doesn't support Windows yet](https://github.com/crystal-lang/crystal/issues/5430) but you can still install Invidious through two kinds of ways:
+
+- By installing [Docker desktop](https://docs.docker.com/desktop/install/windows-install/) and then following [our guide about Docker](#docker).
+- By installing [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about) and then following [our guide about Linux](#linux).
+
 ## Post-install configuration:
 
 Detailed configuration available in the [configuration guide](./configuration.md).