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

Improvements on documentation #165

Merged

Conversation

tgonzalezorlandoarm
Copy link
Member

  • Correct information on cross compilation
  • Change git clone to use https and NOT ssh

@@ -22,7 +22,7 @@ cargo install parsec-tool
For building it, use the following commands:

```
git clone git@github.com:parallaxsecond/parsec-tool.git
git clone https://github.com/parallaxsecond/parsec-book.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Wrong repo?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

It is less confusing to give https based cloning instructions for
public repositories.
Avoid the typical "fatal: could not read from remote repository"
issue.

Signed-off-by: Tomás González <[email protected]>
Copy link
Contributor

@gowthamsk-arm gowthamsk-arm left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks.

@gowthamsk-arm gowthamsk-arm merged commit 470bb6c into parallaxsecond:main Mar 27, 2024
3 of 4 checks passed
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.

2 participants