-
Notifications
You must be signed in to change notification settings - Fork 4
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
Showing
1 changed file
with
22 additions
and
0 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 |
---|---|---|
@@ -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`. |