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

Clarification for the cargo.toml section of Readme's Installation procedure #6

Open
samusz opened this issue Aug 9, 2024 · 1 comment · May be fixed by #8
Open

Clarification for the cargo.toml section of Readme's Installation procedure #6

samusz opened this issue Aug 9, 2024 · 1 comment · May be fixed by #8
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@samusz
Copy link

samusz commented Aug 9, 2024

Hi,

I enjoyed your presentation and hope to be able to test the mentioned gui client when released (no pressure).

For non-rusteans, the installation paragraph of the readme might be less than obvious, as the bullet formatting might be believed to indicate to do both, when in fact, they are mutually exclusive.

The cargo.toml file modification is only for using this crate as a dependency of another program, not for the CLI install (I have seen a colleague fall for this trap).

I would recommend extracting the cargo.toml subsection of the installation section or specify something like 'To use this crate as a lib in your executable (not in the console)' in this section.

Best,

@JR-1991 JR-1991 self-assigned this Aug 13, 2024
@JR-1991 JR-1991 added the documentation Improvements or additions to documentation label Aug 13, 2024
@JR-1991
Copy link
Member

JR-1991 commented Aug 13, 2024

@samusz, thanks for submitting the issue. I am happy you enjoyed the presentation :-)

If I understood it correctly, the Readme should be more precise about using the library and installing the CLI. I am opening a draft PR to work on this and will link it to this issue.

@JR-1991 JR-1991 linked a pull request Aug 13, 2024 that will close this issue
@JR-1991 JR-1991 linked a pull request Aug 13, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants