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

[Documentation] Add Information on cargo install --git #91

Merged
merged 2 commits into from
Apr 1, 2023

Conversation

kevinmatthes
Copy link
Collaborator

This PR fixes #89 by adding a new paragraph to INSTALL.md.

@github-actions
Copy link

github-actions bot commented Mar 31, 2023

Test Results

  3 files  ±0    3 suites  ±0   4s ⏱️ -1s
  9 tests ±0    9 ✔️ ±0  0 💤 ±0  0 ±0 
27 runs  ±0  27 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit f222e6b. ± Comparison against base commit cf2234b.

♻️ This comment has been updated with latest results.

INSTALL.md Outdated Show resolved Hide resolved
@ttytm
Copy link
Owner

ttytm commented Mar 31, 2023

I'd say we can remove the current cargo install --git command from the section above and change the Build from source section as follows.


Build from source

Another way is to compile the app yourself. Assuming the rust toolchain is installed:

  • Use cargo install on the git source

    cargo install --git  https://github.com/tobealive/wthrr-the-weathercrab.git
    
  • Clone the repo and build the release version

    git clone https://github.com/tobealive/wthrr-the-weathercrab.git
    cd wthrr-the-weathercrab
    cargo build --release
    

    When the build has finished, you'll find the wthrr binary inside the ./target/release directory.


This puts cargo install --git as first command to build from source and also splits it from cargo build as it is not performing exactly the same in terms of having a ./target/release output.

@kevinmatthes
Copy link
Collaborator Author

Okay, I will change this tomorrow. But please note that the .git extension on GitHub repository URLs is not mandatory, thus, I would leave the URL as it is, right now.

@ttytm ttytm merged commit e57780b into ttytm:main Apr 1, 2023
@kevinmatthes kevinmatthes deleted the documentation/cargo-install-git branch April 1, 2023 15:51
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.

[Suggestion] cargo install --git
2 participants