# Rust Project Template

[![Crates.io][crates-badge]][crates-url]
[![Github pages][gh-pages-badge]][gh-pages-url]
[![MIT licensed][mit-badge]][mit-url]
[![CI][actions-badge]][actions-url]
[![pre-commit][pre-commit-badge]][pre-commit-url]

[crates-badge]: https://img.shields.io/crates/v/project_template.svg
[crates-url]: https://crates.io/crates/project_template
[gh-pages-badge]: https://github.com/kagemeka/rust_project_template/actions/workflows/pages/pages-build-deployment/badge.svg
[gh-pages-url]: https://kagemeka.github.io/rust_project_template
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/kagemeka/rust_project_template/blob/main/LICENSE
[docs-url]: https://docs.rs/project_template
[actions-badge]: https://github.com/kagemeka/rust_project_template/actions/workflows/rust.yml/badge.svg
[actions-url]: https://github.com/kagemeka/rust_project_template/actions/workflows/rust.yml
[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
[pre-commit-url]: https://github.com/pre-commit/pre-commit

## References

* https://doc.rust-lang.org/book/
* https://doc.rust-lang.org/error-index.html
* https://doc.rust-lang.org/nightly/unstable-book/index.html
* https://doc.rust-lang.org/stable/cargo/
* https://doc.rust-lang.org/stable/edition-guide/
* https://doc.rust-lang.org/stable/embedded-book/
* https://doc.rust-lang.org/stable/nomicon/
* https://doc.rust-lang.org/stable/reference/
* https://doc.rust-lang.org/stable/rust-by-example/
* https://doc.rust-lang.org/stable/rustc/
* https://doc.rust-lang.org/stable/rustdoc/
* https://github.com/rust-lang/rustfmt
* https://rust-cli.github.io/book/index.html
* https://rust-lang-nursery.github.io/rust-cookbook
* https://rust-lang.github.io/api-guidelines
* https://rust-lang.github.io/rfcs
* https://rust-lang.github.io/rust-forge
* https://rust-lang.github.io/rustfmt
* https://rustwasm.github.io/docs/book/
* https://tourofrust.com/
* https://www.rust-lang.org/learn

## Documentation

see [API document][docs-url]

## Naming project

this project's crate name uses hyphens but,
it's prefer to use underscores instead of hyphens in Rust projects.

## Publish to https://crates.io

* https://doc.rust-lang.org/cargo/reference/publishing.html