Skip to content
/ rust-cli-template Public template

A personal template for CLI projects in Rust

License

Notifications You must be signed in to change notification settings

kbknapp/rust-cli-template

Repository files navigation

{{project-name}}

Rust Version crates.io Documentation Dependency Status

@TODO: about

Table of Contents

The Pitch

@TODO: pitch

The Anit-Pitch

@TODO: anti-pitch

Installation

{{crate_name}} is a single binary that must be placed somewhere in your $PATH. One can either download 64-bit Linux binaries from the Release Page or one can also compile from source.

Compile from Source

Ensure you have a Rust toolchain installed. Some of the dependencies also require gcc to be installed.

$ git clone https://github.com/kbknapp/{{project-name}}
$ cd {{project-name}}
$ cargo build --release
$ sudo cp target/release/{{crate_name}} /usr/local/bin/

Usage

Command Line Interface

@TODO: cli usage

License

This crate is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

A personal template for CLI projects in Rust

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages