Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vishruth-thimmaiah committed Dec 7, 2024
1 parent fdd40c4 commit 3628385
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
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
```

0 comments on commit 3628385

Please sign in to comment.