docs: update documentation for non-x86-64 linux installs
-# Installation Guide
+# Install Enarx from Source
+
+This installation guide is for installing Enarx from source. For pre-compiled binaries, please reference the quickstart document available [here](Quickstart).
## Introduction
@@ -104,10 +106,10 @@ kvm 10 1 kvm_amd
## Initial Setup
Please choose one of the following:
-* [Linux x86_64](#linux-x86_64-install-dependencies)
-* [64-bit Arm: (Raspberry Pi or Apple M1) and Apple x86_64](#64-bit-arm-build-dependencies-raspberry-pi-or-apple-m1-and-apple-x86_64)
+* [Linux Install Dependencies](#linux-install-dependencies)
+* [MacOS Install Dependencies](#macos-install-dependencies)
-### Linux x86_64 Install Dependencies
+### Linux Install Dependencies
Please find instructions for your Linux distribution:
@@ -172,16 +174,29 @@ Failure to do so might result in weird failures at runtime.
:::
-### 64-bit Arm build dependencies: (Raspberry Pi 4 or Apple M1) and Apple x86_64
+### MacOS Install Dependencies
-The architectures support development only, using the "nil" backend, so you only need to install the Rust toolchain.
+#### Install Xcode
+Compiling enarx on MacOS requires Xcode to be installed:
+```console
+xcode-select --install
+sudo xcodebuild -license
+```
### Install Rust
+
+For installing Rust on Linux and MacOS please run the following:
```sh
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly -y
$ source $HOME/.cargo/env
```
+For installing Rust on Windows X86_64 please open a command prompt and run the following commands:
+```console
+C:\Users\User> curl.exe --output rustup-init.exe --url https://winget.rustup.rs/x86_64
+C:\Users\User> rustup_init.exe --default-toolchain nightly -y
+```
+
## Installing Enarx
You can install Enarx from GitHub, crates.io, or Nix.
@@ -200,11 +215,18 @@ Rust version nightly-2022-05-03 is required when installing Enarx 0.5.1 from cra
:::
+For installing Enarx from crates.io on X86_64 Linux please run:
```sh:crates;
$ rustup toolchain install nightly-2022-05-03 -t x86_64-unknown-linux-musl,x86_64-unknown-linux-gnu,x86_64-unknown-none
$ CARGO_TARGET_X86_64_UNKNOWN_NONE_RUSTFLAGS="-C linker=gcc" cargo +nightly-2022-05-03 -Z bindeps install --bin enarx --version 0.5.1 -- enarx
```
+For installing Enarx from crates.io on non-x86_64 Linux please run:
+```console
+$ rustup toolchain install nightly-2022-05-03
+$ cargo +nightly-2022-05-03 -Z bindeps install --bin enarx --version 0.5.1 -- enarx
+```
+
### Install from Nix
Users with `nix` package manager installed (see https://nixos.org) should be able to just do in the checked out repository:
