Merge pull request #8 from SimplePixelFont/improve/cli-tool

Improve Builder Workflow & Polish README.md

Author: The-Nice-One

.ci/build_tarballs.jl

@@ -44,9 +44,12 @@ println("Registry written.")
 try
     run(`git config user.name  "github-actions[bot]"`)
     run(`git config user.email "github-actions[bot]@users.noreply.github.com"`)
+    run(`git switch -c chore/update-registry`)
     run(`git add $registry_path`)
-    run(`git commit -m "chore: update registry for $target_name v$version"`)
-    run(`git push origin main`)
+    run(`git commit -m "update registry for $target_name v$version"`)
+    run(`git push -u origin chore/update-registry`)
+    run(`gh pr create --title "Update registry for $target_name v$version"`)
+    run(`gh pr merge --auto --merge --delete-branch`)
     println("✅ Registry pushed.")
 catch e
     println("⚠️  Could not push registry: $e")

.ci/release.jl

@@ -2,12 +2,15 @@
 
 A compiler toolchain Command Line Interface (CLI) for SimplePixelFonts (SPFs).
 
-> [!IMPORTANT]
-> SPFC is experimental software, expect bugs and limited functionality. Regardless, efforts are dedicated to bridging the gap between SPF and the standardized and traditional TrueType Fonts (TTF).
+`spfc` is dedicated to bridging the gap between SPF and multiple different font formats such as; the standardized and traditional TrueType Fonts (TTF), and a dedicated PICO8 custom font cartridge format (P8).
 
-# Usage
+# Installing
+
+Pre-built binaries for common platforms like Windows, MacOS, and Linux are provided in the [releases](https://github.com/SimplePixelFont/spfc/releases?q=cli&expanded=true). You can download the appropriate archive, extract it, and execute the binary found in the folder.
+
+# Building
 
-This tool is written in Rust, you can bulld and run the project with the following pre-requisites:
+`spfc` is written in Rust, you can build and run the project with the following pre-requisites:
 
 * [Rust toolchain](https://www.rust-lang.org/tools/install)
 * [Git](https://git-scm.com/install/) (Optional)
@@ -25,38 +28,24 @@ Then build and install the binary with Cargo.
 cargo install --path .
 ```
 
-Finally, run `spfc`.
+# Usage
+
 ```bash
 spfc --help
 ```
 ```
 SimplePixelFont Compiler Toolchain
 
-Usage: spfc [OPTIONS] --input <INPUT>
+Usage: spfc <COMMAND>
+
+Commands:
+  compile          
+  install          Install a new target backend
+  list             List all available targets from the registry
+  update-registry  Update the plugin registry by fetching the latest information from the SimplePixelFont/spfc GitHub repository
+  help             Print this message or the help of the given subcommand(s)
 
 Options:
-  -i, --input <INPUT>
-          Input SimplePixelFont file path
-  -o, --output <OUTPUT>
-          Output TTF file path [default: output.ttf]
-  -f, --family-name <FAMILY_NAME>
-          Name of the font family [default: SimplePixelFont]
-  -c, --copyright <COPYRIGHT>
-          Description of the font copyright [default: "Copyright (c) 2026 SimplePixelFont"]
-  -m, --manufacturer <MANUFACTURER>
-          Name of the font manufacturer [default: SimplePixelFont]
-  -v, --vendor-url <VENDOR_URL>
-          URL of the font vendor [default: https://github.com/SimplePixelFont]
-  -l, --license-description <LICENSE_DESCRIPTION>
-          Description of the font license [default: "Licensed under the Apache License, Version 2.0; you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0"]
-  -f, --family-version <FAMILY_VERSION>
-          Version of the font family [default: 1]
-  -p, --pixel-size <PIXEL_SIZE>
-          Pixel size in font units [default: 64]
-  -d, --decender-pixels <DECENDER_PIXELS>
-          Decender size in pixels [default: 0]
-  -h, --help
-          Print help
-  -V, --version
-          Print version
+  -h, --help     Print help
+  -V, --version  Print version
 ```