Skip to content

README.md

Latest commit

 

History

History
28 lines (20 loc) · 765 Bytes

README.md

File metadata and controls

28 lines (20 loc) · 765 Bytes

BitPet CLI

CLI tool to create and manage your BitPet (https://bitpet.dev).

Development Environment

Prerequisites

  • Rust (latest stable version)
  • Cargo (comes with Rust..)

Quick Setup

  1. Install project dependencies:

    cargo build

    This will download and compile all dependencies listed in Cargo.toml.

  2. Run the CLI:

    cargo run -- --help   # Run with arguments

Release new version

  • Update version in Cargo.toml
  • Push to the main branch
  • Add a new tag that corresponds to the new version with a v prefix. For example, if the new version is 0.1.0, the tag should be v0.1.0. This will run a circleci workflow that will build the binary and release it to the GitHub Releases page.