honeybadgr

Simple utility used to generate badge svg files.

Table of Contents

[[TOC]]

Introduction

[!note] The structure and functions for most of the badge module have been inspired by the badgers crate. This crate made changes to enable usage within a binary.

Installation

To install this binary you can follow the following steps based on your use-case.

Install from crates.io

On a host with the Rust toolchain installed with crates.io configured as your registry, run:

cargo install honeybadgr
honeybadgr -V

Build from Source

You can build the binary from source by performing the following commands:

git clone git@gitlab.com:ngreese/honeybadgr.git
cd ./honeybadgr
# If you only want to run the program using cargo
cargo run -- <ARGS>
# If you want to build the release binary and copy it to your bin directory.
cargo build --release
cp target/release/honeybadgr /usr/local/bin # or any other location in your $PATH

Usage

The below snippet contains the programs flags with their respective descriptions, arguments, and defaults.

Usage: honeybadgr [OPTIONS]

Options:
  -o, --out-file <OUT_FILE>
          Path to the output file [default: ./honeybadgr.svg]
  -k, --key-text <KEY_TEXT>
          Text to use in the 'key' portion of the badge [default: honeybadgr]
      --key-color <KEY_COLOR>
          Color of the 'key' portion of the badge. Must be a hexadecimal value (e.g. #RRGGBB) [default: #5d5d5d]
      --key-font-color <KEY_FONT_COLOR>
          Color of the 'key' portions text. Must be a hexadecimal value (e.g. #RRGGBB) [default: #eaeaea]
  -v, --value-text <VALUE_TEXT>
          Text to use in the 'value' portion of the badge [default: "don't care"]
      --value-color <VALUE_COLOR>
          Color of the 'value' portion of the badge. Must be a hexadecimal value (e.g. #RRGGBB) [default: #a0a0a0]
      --value-font-color <VALUE_FONT_COLOR>
          Color of the 'value' portions text. Must be a hexadecimal value (e.g. #RRGGBB) [default: #eaeaea]
      --font <FONT>
          Path to a ttf font file to use in the generated badge [default: /home/ngreese/workspace/rust/honeybadgr/assets/DejaVuSans.ttf]
  -h, --help
          Print help
  -V, --version
          Print version