xoac/crates-io-lib-template

cargo-io-lib-template

This is tweaked cargo init --lib for FOSS

This is tweaked cargo init --lib for FOSS. It contains recommendations from cargo book.

What this template provide?:

  • Follow Rust API Guidelines
    • license MIT OR APACHE v2.0
  • Contains default README.tpl that help you generate README.md with cargo-readme
  • Contains CHANGELOG.md that follow keepchangelog
  • Quick start CI workflow on stable rust:
    • cargo check
    • cargo test
    • cargo fmt
    • cargo clippy -- -D warnings

pre-requires:

Installed:

  • cargo-generate cargo install --git https://github.com/ashleygwilliams/cargo-generate (see issue #1)
  • cargo-readme cargo install cargo-readme

How to use:

You need to do four simple steps:

1. Use cargo generate to clone this template

cargo generate --git https://github.com/xoac/crates-io-lib-template.git --name my-project
cd my-project

Learn more about cargo generate here.

2. Update CHANGELOG.md and README.tpl Cargo.toml

You need to replace GITHUB_ORG_PATH with your organization path. For example for this project the GITHUB_ORG_PATH would be https://github.com/xoac/ (remember about last /).

You can do this with sed or with your IDE.

sed -i 's/GITHUB_ORG_PATH/https:\/\/github\.com\/xoac\//g' README.tpl CHANGELOG.md Cargo.toml

This is limitation because of this issue.

3. Update Cargo.toml

Edit Cargo.toml there are some basic information you should provide (look for TODO).

Learn more about Cargo.toml here.

This is limitation because of this issue.

4. Replace this README.md

Add documentation at top of src/lib.rs and generate README.md from that with:

cargo readme > README.md

Lern more about cargo readme here.

Issues

Collection of the latest Issues

Information - Updated Sep 20, 2021

Stars: 2
Forks: 1
Issues: 2
IDE

3.5K

Rust Language Server (RLS)

The RLS provides a server that runs in the background, providing IDEs,

Rust Language Server (RLS)

Rust lang bookmarking tool

Rust and Rocket used bookmarking tool for search bar

Rust lang bookmarking tool

Rust Language Security

execrices: RUSTSEC-2021-0001

Rust Language Security

False Positive for rust-lang/rust#83583

The deprecation lint proc_macro_derive_resolution_fallback is intended to catch proc macro generated code that refers to items from parent modules that should not be in scope:

False Positive for rust-lang/rust#83583

rust_icu: low-level rust language bindings for the ICU library

See: The latest version of this file is available at

rust_icu: low-level rust language bindings for the ICU library

Rust lang exercises

Personal tips and drills in my journey as a beginner rustacean

Rust lang exercises

😍 Rust Language

👍 Download and execute rustup

😍 Rust Language

TensorFlow Rust provides idiomatic Rust language

bindings for Documentation

TensorFlow Rust provides idiomatic Rust language

Rust Language Learning material

Rust is blazingly fast systems programming language that prevents segfaults and guarantees thread safety

Rust Language Learning material

leetcode in rust lang

立个flag一年刷完leetcode

leetcode in rust lang
Facebook Instagram Twitter GitHub Dribbble
Privacy