diff --git a/README.md b/README.md index 7c80ce3..2530603 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,37 @@ # Sloppee -## W.I.P +### (W.I.P) -### To run: +## Installation + +### Install LLVM +This can be done by installing LLVM from the official website: +https://releases.llvm.org/download.html + +You can also install LLVM from your package manager. +For example, on Arch: +```bash +pacman -S llvm +``` + +### Install Rust: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -cargo run -- [OPTIONS] + +## Usage + +### Build a binary: +```bash +cargo build ``` -### to run tests: +### Run the compiler: +```bash +sloppee [COMMAND] [OPTIONS] ``` + +### Run tests: +```bash cargo test ```