From 0134d1f12f72689c6085d82cf7308d100cc769b7 Mon Sep 17 00:00:00 2001 From: George <31376482+george-gca@users.noreply.github.com> Date: Tue, 2 Jan 2024 22:51:42 -0300 Subject: [PATCH] Added information about using wsl on Windows (#2040) Signed-off-by: George Araujo --- INSTALL.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index ffdd9e406ba1..2a7d3eb58464 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -16,6 +16,10 @@ $ git clone git@github.com:/.git Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles: +## Local setup on Windows + +If you are using Windows, it is **highly recommended** to use [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install), which is a compatibility layer for running Linux on top of Windows. You can follow [these instructions](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support) to install WSL and Ubuntu on your machine. You only need to go up to the step 4 of the tutorial (you don't have to enable the optional `systemd` nor the graphical applications), and then you can follow the instructions below to install docker. You can install docker natively on Windows as well, but it has been having some issues as can be seen in #1540, #2007. + ## Local setup using Docker (Recommended) Using Docker to install Jekyll and Ruby dependencies is the easiest way.