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: setup and cli installation details #584

Merged
merged 3 commits into from
Oct 5, 2023

Conversation

ruvaag
Copy link
Contributor

@ruvaag ruvaag commented Oct 4, 2023

Give an overview of the tasks completed

  • Adds docs to setup and install Arbiter CLI, building from source
  • README typo fix

Link to issue(s) that this PR closes
Resolves #557

# CLI Installation with Cargo

## Prerequisites
The best way to build Arbiter today is from source.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would actually say that it's much easier to install from crates with cargo install arbiter than from the source. I think it's good to include instructions for both but i crates is easier because you don't have to build from src.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point. will rework this part and probably just nix this particular line

Copy link
Collaborator

@0xJepsen 0xJepsen left a comment

Choose a reason for hiding this comment

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

Looks really great! I think we are missing instructions on installing with cargo

@ruvaag ruvaag requested a review from 0xJepsen October 4, 2023 04:08
Copy link
Collaborator

@0xJepsen 0xJepsen left a comment

Choose a reason for hiding this comment

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

Looks good!

@codecov
Copy link

codecov bot commented Oct 4, 2023

Codecov Report

Merging #584 (6a03c32) into main (3d29acc) will not change coverage.
Report is 3 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #584   +/-   ##
=======================================
  Coverage   58.75%   58.75%           
=======================================
  Files          11       11           
  Lines        3722     3722           
=======================================
  Hits         2187     2187           
  Misses       1535     1535           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@0xJepsen
Copy link
Collaborator

0xJepsen commented Oct 5, 2023

Paging @Autoparallel or @kinrezC for a review here

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.

Awesome work! I love to see the docs come along :)

@0xJepsen 0xJepsen merged commit 87c5ca0 into anthias-labs:main Oct 5, 2023
@ruvaag ruvaag deleted the setup-cli-docs branch October 12, 2023 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants