template init

Author: EnigmaCurry

template/.github/workflows/release.yml .github/workflows/release.ymltemplate/.github/workflows/release.yml renamed to .github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
         run: rustup toolchain install stable
       # Preprocess Cargo.lock to ignore version fields for cache id hashing purposes:
 
-      - name: Prepare Cargo.lock for caching (ignore ${APP} version)
+      - name: Prepare Cargo.lock for caching (ignore rust-cli-template version)
         run: |
           PROJECT_NAME=$(grep '^name' Cargo.toml | sed 's/name = "\(.*\)"/\1/')
           awk '/\[\[package\]\]/{p=0} /name = "'"${PROJECT_NAME}"'"/{p=1} p && /version = /{next} 1' Cargo.lock > Cargo.lock.no-version
@@ -88,37 +88,37 @@ jobs:
           - release_for: Linux-x86_64
             os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            bin: ${APP}
+            bin: rust-cli-template
             name: Linux-x86_64
             command: build
           - release_for: Linux-aarch64
             os: ubuntu-latest
             target: aarch64-unknown-linux-gnu
-            bin: ${APP}
+            bin: rust-cli-template
             name: Linux-aarch64
             command: build
           - release_for: macOS-x86_64
             os: macOS-latest
             target: x86_64-apple-darwin
-            bin: ${APP}
+            bin: rust-cli-template
             name: Darwin-x86_64
             command: build
           - release_for: macOS-arm64
             os: macOS-latest
             target: aarch64-apple-darwin
-            bin: ${APP}
+            bin: rust-cli-template
             name: Darwin-arm64
             command: build
           # - release_for: Windows-x86_64
           #   os: windows-latest
           #   target: x86_64-pc-windows-msvc
-          #   bin: ${APP}.exe
+          #   bin: rust-cli-template.exe
           #   name: Windows-x86_64
           #   command: build
           # - release_for: FreeBSD-x86_64
           #   os: ubuntu-latest
           #   target: x86_64-unknown-freebsd
-          #   bin: ${APP}
+          #   bin: rust-cli-template
           #   name: FreeBSD-x86_64
           #   command: build
 
@@ -136,7 +136,7 @@ jobs:
       if: startsWith(github.ref, 'refs/tags/v')
       with:
         files: |
-          ${APP}-v*.tar.gz/${APP}-v*.tar.gz
+          rust-cli-template-v*.tar.gz/rust-cli-template-v*.tar.gz
 
   publish:
     name: Publish crate
@@ -150,7 +150,7 @@ jobs:
 
 
     # Preprocess Cargo.lock to ignore version fields for cache id hashing purposes:
-    - name: Prepare Cargo.lock for caching (ignore ${APP} version)
+    - name: Prepare Cargo.lock for caching (ignore rust-cli-template version)
       run: |
         PROJECT_NAME=$(grep '^name' Cargo.toml | sed 's/name = "\(.*\)"/\1/')
         awk '/\[\[package\]\]/{p=0} /name = "'"${PROJECT_NAME}"'"/{p=1} p && /version = /{next} 1' Cargo.lock > /tmp/Cargo.lock.no-version

template/.github/workflows/rust.yml .github/workflows/rust.ymltemplate/.github/workflows/rust.yml renamed to .github/workflows/rust.yml

@@ -21,7 +21,7 @@ jobs:
       uses: actions/checkout@v4
 
     # Preprocess Cargo.lock to ignore version fields for cache id hashing purposes:
-    - name: Prepare Cargo.lock for caching (ignore ${APP} version)
+    - name: Prepare Cargo.lock for caching (ignore rust-cli-template version)
       run: |
         PROJECT_NAME=$(grep '^name' Cargo.toml | sed 's/name = "\(.*\)"/\1/')
         awk '/\[\[package\]\]/{p=0} /name = "'"${PROJECT_NAME}"'"/{p=1} p && /version = /{next} 1' Cargo.lock > Cargo.lock.no-version

template/.gitignore .gitignoretemplate/.gitignore renamed to .gitignore

@@ -1,15 +1,15 @@
 [package]
-name = "${APP}"
-description = "${APP} is a CLI tool"
+name = "rust-cli-template"
+description = "rust-cli-template is a CLI tool"
 version = "0.1.0"
 edition = "2021"
-repository = "https://github.com/${GIT_USERNAME}/${APP}"
-homepage = "https://github.com/${GIT_USERNAME}/${APP}"
+repository = "https://github.com/EnigmaCurry/rust-cli-template"
+homepage = "https://github.com/EnigmaCurry/rust-cli-template"
 license = "MIT"
 keywords = []
 categories = ["command-line-utilities"]
 readme = "README.md"
-documentation = "https://docs.rs/${APP}"
+documentation = "https://docs.rs/rust-cli-template"
 
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage,coverage_nightly)'] }

template/Cargo.lock Cargo.locktemplate/Cargo.lock renamed to Cargo.lock

@@ -20,9 +20,9 @@ rustup-init ## just press enter when prompted for default selection
 ## Clone source repository
 
 ```
-git clone git@github.com:${GIT_USERNAME}/${APP}.git \
-  ~/git/vendor/${GIT_USERNAME}/${APP}
-cd ~/git/vendor/${GIT_USERNAME}/${APP}
+git clone git@github.com:EnigmaCurry/rust-cli-template.git \
+  ~/git/vendor/EnigmaCurry/rust-cli-template
+cd ~/git/vendor/EnigmaCurry/rust-cli-template
 ```
 
 ## Install development dependencies
@@ -32,7 +32,7 @@ cargo install just
 just deps
 ```
 
-## Build and run development ${APP}
+## Build and run development rust-cli-template
 
 ```
 just run help
@@ -49,18 +49,18 @@ just build --release
 
 ```
 ## Add this to ~/.bashrc or equivalent:
-alias ${APP}='just -f ~/git/vendor/${GIT_USERNAME}/${APP}/Justfile run'
-alias h=${APP}
+alias rust-cli-template='just -f ~/git/vendor/EnigmaCurry/rust-cli-template/Justfile run'
+alias h=rust-cli-template
 ```
 
-Now you can run `${APP}`, or simply `h`, from any directory, with
+Now you can run `rust-cli-template`, or simply `h`, from any directory, with
 any arguments, and it will automatically rebuild from source, and then
 run it with those args.
 
 ## Testing
 
 This project has incomplete testing. [See the latest coverage
-report](https://${GIT_USERNAME}.github.io/${APP}/coverage/master/).
+report](https://EnigmaCurry.github.io/rust-cli-template/coverage/master/).
 
 ## Run tests
 

template/Cargo.toml Cargo.tomltemplate/Cargo.toml renamed to Cargo.toml

@@ -1,4 +1,4 @@
-Copyright 2024 EnigmaCurry
+Copyright 2025 EnigmaCurry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

template/DEVELOPMENT.md DEVELOPMENT.mdtemplate/DEVELOPMENT.md renamed to DEVELOPMENT.md

@@ -1,34 +1,64 @@
 # rust-cli-template
 
-This is my Rust template for new CLI apps.
-
-## Features
-
- * [Just](https://github.com/casey/just) enabled project build targets.
- * [Clap](https://docs.rs/clap/latest/clap/) CLI argument parser.
- * Bash / Fish / Zsh shell (tab)
-   [completion](https://docs.rs/clap_complete/latest/clap_complete/).
- * GitHub actions for tests and releases.
- * Test coverage report published to GitHub pages.
- * Publishing to crates.io.
-
-## Use this template
-
- * [Create a new repository using this template](https://github.com/new?template_name=rust-cli-template&template_owner=EnigmaCurry).
- * The `Repository name` you choose will also be used as your app name.
- * Go to the repository `Settings` page:
-   * Find `Actions`.
-   * Find `General`.
-   * Find `Workflow Permissions`.
-   * Set `Read and Write permissions`.
-   * Click `Save`.
- * Clone your new repository to your workstation.
- 
-## Render the template
-
-```
-./setup.sh
-```
- 
-This will render the template into the project root and then
-self-destruct this README.md and the template.
+[![Crates.io](https://img.shields.io/crates/v/rust-cli-template?color=blue
+)](https://crates.io/crates/rust-cli-template)
+[![Coverage](https://img.shields.io/badge/Coverage-Report-purple)](https://EnigmaCurry.github.io/rust-cli-template/coverage/master/)
+
+
+## Install
+
+[Download the latest release for your platform.](https://github.com/EnigmaCurry/rust-cli-template/releases)
+
+Or install via cargo ([crates.io/crates/rust-cli-template](https://crates.io/crates/rust-cli-template)):
+
+```
+cargo install rust-cli-template
+```
+
+### Tab completion
+
+To install tab completion support, put this in your `~/.bashrc` (assuming you use Bash):
+
+```
+### Bash completion for rust-cli-template (Put this in ~/.bashrc)
+source <(rust-cli-template completions bash)
+```
+
+If you don't like to type out the full name `rust-cli-template`, you can make
+a shorter alias (`h`), as well as enable tab completion for the alias
+(`h`):
+
+```
+### Alias rust-cli-template as h (Put this in ~/.bashrc):
+alias h=rust-cli-template
+complete -F _rust-cli-template -o bashdefault -o default h
+```
+
+Completion for Zsh and/or Fish has also been implemented, but the
+author has not tested this:
+
+```
+### Zsh completion for rust-cli-template (Put this in ~/.zshrc):
+autoload -U compinit; compinit; source <(rust-cli-template completions zsh)
+
+### Fish completion for rust-cli-template (Put this in ~/.config/fish/config.fish):
+rust-cli-template completions fish | source
+```
+
+## Usage
+
+```
+$ rust-cli-template
+
+Usage: rust-cli-template [OPTIONS] [COMMAND]
+
+Commands:
+
+Options:
+  -h, --help                  Print help
+  -V, --version               Print version
+```
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md)