From 2e5e762f17ff6d5758968e4c18749c9b2806c2ab Mon Sep 17 00:00:00 2001 From: PaddiM8 Date: Sun, 12 Nov 2023 23:39:08 +0100 Subject: [PATCH] docs: Warn about non-posix default shell --- docs/getting-started/installation.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 03872ad9..f7c6a8af 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,12 +1,22 @@ # Installation -## Prerequisites +## Pre-built + +Download the latest release ([Linux](https://github.com/PaddiM8/elk/releases/download/v0.0.0/linux-x64.tar.xz), [macOS](https://github.com/PaddiM8/elk/releases/download/v0.0.0/osx-x64.tar.xz)) +and extract it into `/`: +```bash +tar xvf *.tar.xz -C / +``` + +## Manual Compilation + +### Prerequisites * A 64-bit Linux distro (it is possible to modify the `build.sh` file to compile for other platforms, but it may not work as expected) * [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) -## Steps +### Steps Start by cloning the repository: @@ -28,8 +38,14 @@ Elk is now installed and can be accessed with the `elk` command. ### Default Shell -The first step is to add the path to the Elk binary to `/etc/shells` in order -to make your system aware of the existence of the Elk shell. +::: warning +Setting the default shell to a non-posix shell could lead to problems. +An alternative is to add `elk` at the end of your `.bashrc` or equivalent +file. +::: + +When making Elk the default shell, first step is to add the path to the Elk binary to `/etc/shells`. +This makes your system aware of the existence of the shell. After the path has been added to the `/etc/shells` file, Elk can be made the default shell by running the following command: