collatz

collatz is a CLI for printing the hailstone sequence of a number.

index

• Installation
• Building
• Usage
• Make Recipes
• How to Release

Installation

back^

Archives of precompiled binaries for collatz are available for Windows, macOS and Linux.

Building

back^

collatz is written in Rust, so you'll need to grab a Rust installation in order to compile it. To build collatz, run:

git clone [email protected]:rodmoioliveira/collatz.git
cd collatz
make install

Usage

back^

collatz --help

Prints the hailstone sequence of a number

Usage: collatz <NUMBER>

Arguments:
  <NUMBER>
          A positive integer between 0 and 340282366920938463463374607431768211455

Options:
  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Make Recipes

back^

bash-all               Run all bash tests
bash-check             Check format bash code
bash-deps              Install bash dependencies
bash-fmt               Format bash code
bash-lint              Check lint bash code
comments-tidy          Tidy comments within code
doc-changelog          Write CHANGELOG.md
doc-readme             Write README.md
dprint-check           Dprint check
dprint-fmt             Dprint format
help                   Display this help screen
makefile-descriptions  Check if all Makefile rules have descriptions
rs-audit               Audit Cargo.lock
rs-audit-fix           Update Cargo.toml to fix vulnerable dependency requirement
rs-build               Build binary
rs-cargo-deps          Install cargo dependencies
rs-check               Run check
rs-dev                 Run check in watch mode
rs-doc                 Open app documentation
rs-fix                 Fix rust code
rs-fmt                 Format rust code
rs-fmt-fix             Format fix rust code
rs-install             Install binary
rs-lint                Lint rust code
rs-lint-fix            Fix lint rust code
rs-outdated            Display when dependencies are out of date
rs-tests               Run tests
rs-uninstall           Uninstall binary
rs-update-cargo        Update dependencies
rs-update-rustup       Update rust
typos                  Check typos
typos-fix              Fix typos

How to Release

back^

To generate a new version, you need to follow these steps:

1. In the main branch, you must bump the version inside the Cargo.toml file.
2. Run make rs-check so that the version is changed in the Cargo.lock file.
3. Run the command git add -A && git commit -m "release: bump version".
4. Run the command git tag -a <your.new.version> -m "version <your.new.version>".
5. Run the command make doc-changelog && make doc-readme.
6. Run the command git add -A && git commit -m "release: <your.new.version>".
7. Run git push to main.