Skip to content
This repository has been archived by the owner on Jan 8, 2022. It is now read-only.

Missing documentation #3

Closed
Dr-Terrible opened this issue Nov 20, 2017 · 4 comments
Closed

Missing documentation #3

Dr-Terrible opened this issue Nov 20, 2017 · 4 comments

Comments

@Dr-Terrible
Copy link

Please, can you add some kind of documentation that explains how to use and invoke the command-line tool for a real case scenario? People not used to rust/cargo will have hard times figuring it out. Thank you.

@cardoe
Copy link
Owner

cardoe commented Nov 27, 2017

Sure. Basically right now its git clone the project and checkout the tag of the version you want to build and run cargo ebuild. Obviously those steps are a bit much and it'd be nicer to run cargo ebuild <pkg> and have it reach out to crates.io. That's something I need to add.

@Dr-Terrible
Copy link
Author

Obviously those steps are a bit much and it'd be nicer to run cargo ebuild and have it reach out to crates.io.

Indeed, that was my initial confusion. I spent at least an hour trying to figure out why the tool complained and did nothing when I invoked cargo ebuild <github-url>. Only later I realised that I had to clone the repo and run the command on the clone.

That's something I need to add.

That would be awesome, thank you. It's not urgent, btw; I'm fine with manually checking out a repo.

@cardoe cardoe closed this as completed in 079963e Dec 4, 2017
@cardoe
Copy link
Owner

cardoe commented Dec 4, 2017

Does the info provided in the README help? If you'd like to see future improvement please re-open or create a new ticket.

@Dr-Terrible
Copy link
Author

Dr-Terrible commented Dec 4, 2017

I think the new info are quite good 👍
Thank you for the support :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants