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.

Sign up for GitHub

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

Jump to bottom

Waylon/bin docs #417

Merged
merged 6 commits into from
Aug 15, 2023
Merged

Waylon/bin docs #417

merged 6 commits into from
Aug 15, 2023

Conversation

0xJepsen
Copy link
Collaborator

This PR

  • Adds documentation to the binary crate
  • Fixes the bind and init CLI args to use the arbiter template

@0xJepsen
documentation for this module + better logging and a better initializ…
7624215 
…ation command
@0xJepsen
binary crate
c121557 
- fixes old init and bind
- adds comments
- removes prints in favor of logging
Autoparallel
Autoparallel requested changes Aug 15, 2023
View reviewed changes
Copy link
Collaborator

@Autoparallel Autoparallel left a comment

Choose a reason for hiding this comment

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

See the comments!

I also need to go run these commands myself to see what it's like first.

bin/bind.rs Outdated Show resolved Hide resolved
bin/main.rs Show resolved Hide resolved
Cargo.toml Outdated Show resolved Hide resolved
@0xJepsen
Copy link
Collaborator Author

See the comments!

I also need to go run these commands myself to see what it's like first.

Awesome! Yeah my recommendations are to run these in this order (and we should add these to the readme) I'll do that actually

  • arbiter init your-project-name
  • cd your-project-name
  • arbiter bind
  • cargo run

@0xJepsen 0xJepsen marked this pull request as ready for review August 15, 2023 19:55
@Autoparallel
Copy link
Collaborator

  • cd your-project-name
  • arbiter bind

Should we add a possible input for bind to be a path to the your-project-name/ directory and take . as a default?

@0xJepsen 0xJepsen mentioned this pull request Aug 15, 2023
Closed
@0xJepsen
Copy link
Collaborator Author

  • cd your-project-name
  • arbiter bind

Should we add a possible input for bind to be a path to the your-project-name/ directory and take . as a default?

I think that could be good in a later feature, but i think if we add that we should add it post release.

@0xJepsen
Requested changes
13a0f83 
remove log init

made the blockrate an option

added cli instructions to readme

fmt

fmt + clippy
Autoparallel
Autoparallel requested changes Aug 15, 2023
View reviewed changes
arbiter-core/src/environment.rs Outdated Show resolved Hide resolved
Cargo.toml Outdated Show resolved Hide resolved
bin/init.rs Outdated Show resolved Hide resolved
@Autoparallel Autoparallel merged commit f86a8bb into feat/middleware Aug 15, 2023
@0xJepsen 0xJepsen deleted the waylon/bin-docs branch August 16, 2023 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Autoparallel Autoparallel Autoparallel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@0xJepsen @Autoparallel