-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fdd40c4
commit 3628385
Showing
1 changed file
with
29 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 -- <filename> [OPTIONS] | ||
|
||
## Usage | ||
|
||
### Build a binary: | ||
```bash | ||
cargo build | ||
``` | ||
|
||
### to run tests: | ||
### Run the compiler: | ||
```bash | ||
sloppee [COMMAND] <file> [OPTIONS] | ||
``` | ||
|
||
### Run tests: | ||
```bash | ||
cargo test | ||
``` |