Rust

Packaging

Follow the Cargo guide. Nice and simple.

Readme

# PROJECT [![](https://img.shields.io/github/tag/borntyping/PROJECT.svg)](https://github.com/borntyping/PROJECT/tags) [![](https://img.shields.io/travis/borntyping/PROJECT.svg)](https://travis-ci.org/borntyping/PROJECT) [![](https://img.shields.io/github/issues/borntyping/PROJECT.svg)](https://github.com/borntyping/PROJECT/issues)

Project description

* [Source on GitHub](https://github.com/borntyping/PROJECT)
* [Packages on Crates.io](https://crates.io/crates/PROJECT)
* [Builds on Travis CI](https://travis-ci.org/borntyping/PROJECT)

Usage
-----

Run the program using `cargo`:

    cargo run

Licence
-------

`PROJECT` is licenced under the [MIT Licence](http://opensource.org/licenses/MIT).

Authors
-------

Written by [Sam Clements](sam@borntyping.co.uk).

Testing

Test annotations

Code can be annotated to mark it as a test.

Cargo

Run tests with cargo test.

Travis-CI configuration

For a project using Cargo, a .travis.yml is very simple:

language: rust

Checklist

Creating a new package

Package structure
cargo new <project>

Releasing a package

Run tests
cargo test
Update metadata
Change version number in Cargo.toml
Tag release
git-tag-version or git tag -a "v0.1.0" -m "Version 0.1.0"
Package upload
cargo publish

Documentation

Build documentation
cargo doc
Build and open documentation
cargo doc –open