Rust {{ Package-Name}}

intro

Table of Contents

• Table of Contents
  • Showcases
  • Install
  • Documentation
  • TODO
  • Contributing
  • Changelog
  • NOTE

Showcases

first you need to see the showcases to convince you to install it.

1. 1
2. 2

Install

1. the modern and simple way

just run this command

cargo add {{package-name}}

and this will add the latest version from crates.io to your Cargo.toml, just like the old way, but automatically.

• what is cargo add ? -> its a cargo sub command
• how to install it ? -> cargo install cargo-edit
• what is cargo-edit ? -> its a rust package that adds useful sub commands for cargo that are not built-in

2. the old way

just copy the crate name and the version you want to use:

{{package-name}} = "$the_version_you_want"
# example
{{package-name}} = "0.0.6"

to your Cargo.toml and then write some code and build your project that uses {{package-name}}.

Documentation

• docs.rs/{{package-name}}
• the-book

why ?

because i can.

TODO

check TODO.md

Contributing

check CONTRIBUTING.md

Changelog

check CHANGELOG.md

Crates that use {{package-name}}

incoming, would be nice.

NOTE

note for the user and developer

if you find issues go ahead and make an issue or a pull request, cant wait to take a look into them.

right now this project is very minimal, it will grow, the idea just came to my mind some days ago (on 21.02.2022) and the first implementation was done at 4 AM (23.02.2022) with some adrenaline.

so for now dont expect too much of this crate

peace to you!