Improved README

parent 9310225d
......@@ -8,7 +8,19 @@ ehyve is small hypervisor to boot the operating systems [eduOS-rs](https://githu
## Requirements
### macOS
ehyve requires a CPU with Virtualization features (Intel Hyper-V or AMD-V). **Ensure that these are enabled in the BIOS/EFI!**
### OS-Specific:
#### Linux
Linux users should install common developer tools.
For instance, on Ubuntu 18.04 the following command installs the required tools:
```sh
$ apt-get install -y curl wget make autotools-dev gcc g++ build-essential git
```
#### macOS
Apple's *Command Line Tools* must be installed.
The Command Line Tool package gives macOS terminal users many commonly used tools and compilers, that are usually found in default Linux installations.
Following terminal command installs these tools without Apple's IDE Xcode:
......@@ -25,36 +37,29 @@ $ sysctl kern.hv_support
kern.hv_support: 1
```
### Windows
#### Windows
To build eduOS-rs you have to install a linker, [make](http://gnuwin32.sourceforge.net/packages/make.htm) and a [git client](https://git-scm.com/downloads).
We tested the eduOS-rs with the linker from Visual Studio.
Consequently, we suggest installing Visual Studio in addition to [make](http://gnuwin32.sourceforge.net/packages/make.htm) and [git](https://git-scm.com/downloads).
Furthermore, the included hypervisor bases on the [Windows Hypervisor Platform](https://docs.microsoft.com/en-us/virtualization/api/) depending on Windows 10 (build 17134 or above) or Windows Server (1803 or above).
Please activate this feature as *root* by using the following command on your system:
Please activate this feature as *Administrator* by using the following command on your system:
```sh
Dism /Online /Enable-Feature /FeatureName:HypervisorPlatform
```
### Linux
Linux users should install common developer tools.
For instance, on Ubuntu 18.04 the following command installs the required tools:
```sh
$ apt-get install -y curl wget make autotools-dev gcc g++ build-essential
```
### Rust installation
### Common for macOS, Windows and Linux
It is required to install the Rust toolchain.
Please visit the [Rust website](https://www.rust-lang.org/) and follow the installation instructions for your operating system.
It is important that the *nightly channel* is used to install the toolchain.
This is queried during installation and should be answered as appropriate.
Afterwards the installation of *cargo-xbuild* and the source code of Rust runtime are required to build the kernel:
Afterwards the installation of the Rust runtimes source code is required to build the kernel:
```sh
$ cargo install cargo-xbuild
$ rustup component add rust-src
```
......@@ -62,14 +67,10 @@ $ rustup component add rust-src
The final step is to create a copy of the repository and to build the kernel:
```sh
$ # Get our source code.
$ git clone git@github.com:RWTH-OS/ehyve.git
$ cd ehyve
$ # Get a copy of the Rust source code so we can rebuild core
$ # for a bare-metal target.
$ git submodule update --init
$ make
git clone git@github.com:RWTH-OS/ehyve.git
cd ehyve
git submodule update --init
cargo ehyve-run
```
## Licensing
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment