From 5d6bfbb40997b8346b209e1901a240d0108d1ebd Mon Sep 17 00:00:00 2001 From: Ry Date: Tue, 21 Jun 2022 18:56:11 -0700 Subject: [PATCH] Add basic building instructions to the README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7531c30..e93fa9d 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,11 @@ **Note: This software is still very much in an early stage, and is currently more focused towards developers rather than end-users.** -### Requirements +### Building -**fox32** requires Vulkan support to be installed. +Clone this repository, `cd` into it, then clone the [fox32core](https://github.com/fox32-arch/fox32core) repository in a folder called `fox32core`. + +After that, just run `cargo build --release`. The resulting binary will be saved as `target/release/fox32` ### Usage