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

docs: update development guide #427

Merged
merged 5 commits into from
May 13, 2024
Merged

docs: update development guide #427

merged 5 commits into from
May 13, 2024

Conversation

gardleopard
Copy link
Contributor

Adding a few cargo commands to make it easier for contributors to discover.

@@ -27,6 +27,9 @@ cp hooks/* .git/hooks/
- `cargo test` - Run the tests
- `cargo build` - Build a debug build. The executable will be available in ./target/debug/unleash-edge once successful
- `cargo build --release` - Build a release build. The executable will be available in ./target/release/unleash-edge once successful. - If you want to run loadtesting, you should really build in release mode. 10-20x faster than the debug build
- `cargo run -- edge --markdown-help -u http://localhost:4242 > CLI.md` - Update the CLI.md file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this new? I don't remember a CLI file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not know, I learned it from @chriswk

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay Chris explained it to me. That's very nice

Copy link
Member

@sighphyre sighphyre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, very nice

@chriswk chriswk enabled auto-merge (squash) February 29, 2024 14:50
@chriswk chriswk disabled auto-merge May 13, 2024 08:18
@chriswk chriswk merged commit bd3bf4a into main May 13, 2024
6 checks passed
@chriswk chriswk deleted the development-guide branch May 13, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants