Skip to content

README.md

Latest commit

 

History

History
151 lines (102 loc) · 3.11 KB

README.md

File metadata and controls

151 lines (102 loc) · 3.11 KB
Raw

Figurine

PkgGoDev GitHub go.mod Go version Go Report Card License

Print your name in style

Screenshot

Table of Contents

  1. Installation
  2. Usage
  3. Docker
  4. Building from Source
  5. Creating Releases
  6. See Also
  7. License

Installation

You can download the latest binary from here, or you can compile from source:

go install github.com/arsham/figurine@latest

Usage

Every time the application is called, it chooses a random font for rendering the message. Pass the message you want to decorate as arguments.

figurine Some Text

You can print available fonts:

figurine -l
figurine -l -s
figurine -ls Sample Text

To set a font:

figurine -f "Poison.flf" Some Text

To get a list of available arguments:

figurine -h

This application is very light weight, so feel free to add it to your .zshrc/.bashrc file, so each time you open a new shell it shows you a nice message.

Docker

To build the Docker image:

make docker-build

To run the Docker container:

make docker-run

To build multi-platform Docker images (requires Docker Buildx):

make docker-buildx

To clean up the Docker image and container:

make docker-clean

Building from Source

Local Development Build

To build the project for your local machine:

make build

Cross-Platform Builds

To build for multiple platforms (Linux, macOS, Windows):

make build-all

This creates binaries in the dist folder for the following platforms:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64)

Each binary is compressed into a tar.gz archive with platform-specific naming.

Creating Releases

Manual Release

  1. Build all platform binaries:

    make release

  2. This will create compressed archives and a checksums.txt file in the dist folder.

Automated Release

Releases are automated using GitHub Actions. To create a new release:

  1. Tag the commit with a version number:

    git tag v1.0.0
git push origin v1.0.0

  2. GitHub Actions will automatically:

    • Build binaries for all supported platforms
    • Create a new GitHub Release with the binaries
    • Build and push Docker images to Docker Hub (if configured)

See Also

See also Rainbow, which is the library that colours the output.

License

Use of this source code is governed by the Apache 2.0 license. License that can be found in the LICENSE file.