Skip to content

Commit

Permalink
docs: Warn about non-posix default shell
Browse files Browse the repository at this point in the history
  • Loading branch information
PaddiM8 committed Nov 12, 2023
1 parent b4a510c commit 2e5e762
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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:
Expand Down

0 comments on commit 2e5e762

Please sign in to comment.