Updated README

This commit is contained in:
Skye Bleed 2019-09-05 19:15:30 -05:00
parent 7e4f8c5da7
commit 1dac309bb5
1 changed files with 5 additions and 1 deletions

View File

@ -16,7 +16,11 @@ This has hardly been worked on and is essentially useless at its current state.
[ ] More, probably
### Building and Setup
This project is made in the rust programming language, so a simple `cargo run` will suffice to build the binary. In addition, you may wish to run `scripts/setup.sh` to configure your environment. Soon, the setup script will be written in lua and instructions on how to do so from bash will be here.
A build and setup script has been included as `scripts/build`, but as it is written in Lua, you may wish to setup yourself. To do that,
1. Run `cargo build --release`
2. Run `scripts/setup.sh`
3. Run `scripts/mkenv.sh arch_core` to setup the arch core repo
4. Add /usr/pack/bin to path
### Usage
Firstly, to setup your environment, run scripts/arch.sh. The syntax of the command is as follows: