Skip to content

Commit

Permalink
Merge
Browse files Browse the repository at this point in the history
  • Loading branch information
BradenEverson committed Feb 12, 2024
2 parents 256d41b + 0356128 commit a63fb36
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to unda

Thanks for taking the time to contribute! :tada::+1:

As a singular college student working on this crate for fun to better understand rust and machine learning it really does mean a lot :)

## Development

### Running code locally

Assuming you downloaded unda to `/home/user/unda` and you want to run
the crate locally, it's relatively self explanatory as you would run any rust project:
```bash
cd /home/user/unda
cargo build --release
./target/release/unda
```
Once changes are made, please make a new branch and submit a PR :)

### Running tests

Nothing special, just `cargo test`.

0 comments on commit a63fb36

Please sign in to comment.