https://github.com/jmcph4/clcat
https://github.com/jmcph4/clcat
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jmcph4/clcat
- Owner: jmcph4
- License: mit
- Created: 2023-09-06T05:28:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T05:59:32.000Z (almost 3 years ago)
- Last Synced: 2025-02-16T00:44:46.488Z (over 1 year ago)
- Language: Rust
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust Program Template #
This is a template for a program written in Rust.
## Usage ##
### Things you need to do ###
Suppose your program is called "ethtool".
1. `sed -i "s/foobar/ethtool/gI" Cargo.toml`
2. `sed -i "s/Foobar/EthTool/gI" src/*.rs`
3. Manually populate `LICENSE` (optionally replacing it altogether)
4. Manually populate `Cargo.toml` with [the necessary fields](https://doc.rust-lang.org/cargo/reference/manifest.html)
5. `rm -rf .git && git init` (reinitialise Git repository for your project; **ignore if you're using the GitHub template feature**)
6. ???
7. Profit
## Features ##
- Global error type allowing ready use of the question mark operator
- Derived Clap-v3-style CLI
- Asynchronous by default
- GitHub Actions workflow for CI/CD
## Motivation ##
For most applications, I would wager boilerplate obeys a [power law](https://en.wikipedia.org/wiki/Power_law). This template aims to capture the vast majority of such boilerplate by targeting the least common denominator of functionality amongst the various domains I work on.