From fea7e9ddb9aa1a0b336ff6961adfa019227c6366 Mon Sep 17 00:00:00 2001 From: Jean-Gabriel Gill-Couture Date: Thu, 26 Jun 2025 12:40:39 -0400 Subject: [PATCH] doc: Improve harmony_composer README single command usage --- harmony_composer/README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/harmony_composer/README.md b/harmony_composer/README.md index 279ad8a..efd5e99 100644 --- a/harmony_composer/README.md +++ b/harmony_composer/README.md @@ -9,12 +9,19 @@ It's designed to simplify the build process by either compiling a Harmony projec You can download and run the latest snapshot build with a single command. This will place the binary in ~/.local/bin, which should be in your PATH on most modern Linux distributions. ```bash - -curl -Ls https://git.nationtech.io/NationTech/harmony/releases/download/snapshot-latest/harmony_composer \ +curl -L https://git.nationtech.io/NationTech/harmony/releases/download/snapshot-latest/harmony_composer \ -o ~/.local/bin/harmony_composer && \ -chmod +x ~/.local/bin/harmony_composer +chmod +x ~/.local/bin/harmony_composer && \ +alias hc=~/.local/bin/harmony_composer && \ +echo "\n\nharmony_composer installed successfully\!\n\nUse \`hc\` to run it.\n\nNote : this hc alias only works for the current shell session. Add 'alias hc=~/.local/bin/harmony_composer' to your '~/.bashrc' or '~/.zshrc' file to make it permanently available to your user." ``` +Then you can start using it with either : + +- `harmony_composer` if `~/.local/bin` is in you `$PATH` +- `hc` alias set up in your current shell session. + - If you want to make the `hc` command always available, add `alias hc=~/.local/bin/harmony_composer` to your shell profile. Usually `~/.bashrc` for bash, `~/.zshrc` for zsh. + > ⚠️ Warning: Unstable Builds > The snapshot-latest tag points to the latest build from the master branch. It is unstable, unsupported, and intended only for early testing of new features. Please do not use it in production environments.