build directions

This commit is contained in:
Cadey Ratio 2020-04-18 17:08:07 -04:00
parent ff6759bb29
commit 783d6c7ddc
1 changed files with 24 additions and 0 deletions

24
doc/BUILDING.md Normal file
View File

@ -0,0 +1,24 @@
# Build Directions
## EASY METHOD
- Install [nix][nix]
- Run `nix-shell` in the XeOS folder
- Run `cargo xbuild` in the XeOS folder
[nix]: https://nixos.org/nix/
## Less easy method
```
$ rustup install nightly-2020-04-08
$ rustup default nightly-2020-04-08
$ cargo install cargo-xbuild
$ cargo install bootloader
$ cargo xbuild
```
Other versions of Rust might work, but the version listed in
[`rust.nix`][rustnix] is the most accurate.
[rustnix]: https://tulpa.dev/cadey/XeOS/src/branch/master/nix/rust.nix