Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.0.0 #1

Merged
merged 18 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update readme installation
  • Loading branch information
nfurfaro committed Jan 22, 2024
commit f7e0c8890cf2a28a9590fb0cebf75875088fecc3
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,35 @@ At a high level, Hunter exposes a CLI with 2 primary commands, scan and mutate.

## Installation

There are 2 ways to install Hunter: via cURL or by building from source.
### cURL

1. Download the binary using cURL:
`curl -LO https://github.com/<username>/<repo>/releases/download/<tag>/hunter`

2. Make the binary executable:
`chmod +x hunter`

3. Move the binary to a directory in your PATH (i.e: /usr/local/bin):
`mv hunter /usr/local/bin`

You should now be able to run the program by typing `hunter` in your terminal!

### Build from source

Alternatively, you can build Hunter from source. To do so, you'll need to have Rust installed. If you don't have Rust installed, you can install it by following the instructions [here](https://www.rust-lang.org/tools/install).

1. Clone the repo:
`git clone git@github.com:nfurfaro/hunter.git`

2. Build the project:
`cargo build --release`

3. Move the binary to a directory in your PATH (i.e: /usr/local/bin):
`mv ./target/release/hunter /usr/local/bin`

You should now be able to run the program by typing `hunter` in your terminal!

## Quickstart

The simplest way to get started with Hunter is to `$ cd` into the root of the project you want to test. From there, it is recommended to run the scan command:
Expand Down
2 changes: 1 addition & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub async fn run_cli() -> Result<()> {
if args.info {
println!(
"{}",
"Welcome to Hunter, a multi-language mutation-testing tool.".cyan()
"Welcome to Hunter, a mutation-testing tool for Noir source code.".cyan()
);
return Ok(());
}
Expand Down