Skip to content

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

@samusz

Description

@samusz

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,

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions