readme

README.md

@@ -44,16 +44,21 @@ Flags:
 
 Use "mrpack-install [command] --help" for more information about a command.
 ```
-#### modpack update
+#### plain server deployment
 ```
-Update the deployed modpacks files, creating backups if necessary.
+Download and configure one of several Minecraft server flavors.
 
 Usage:
-  mrpack-install update [<version>] [flags]
+  mrpack-install server ( vanilla | fabric | quilt | forge | neoforge | paper ) [flags]
+
+Examples:
+  mrpack-install server fabric --server-dir fabric-srv
+  mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
 
 Flags:
-      --backup-dir string   Backup directory path
-  -h, --help                help for update
+      --flavor-version string      Flavor version (default "latest")
+  -h, --help                       help for server
+      --minecraft-version string   Minecraft version (default "latest")
 
 Global Flags:
       --dl-retries uint8     Retries when download fails (default 3)
@@ -64,21 +69,16 @@ Global Flags:
       --server-file string   Server jar file name
   -v, --verbose              Enable verbose output
 ```
-#### plain server deployment
+#### modpack update
 ```
-Download and configure one of several Minecraft server flavors.
+Update the deployed modpacks files, creating backups if necessary.
 
 Usage:
-  mrpack-install server ( vanilla | fabric | quilt | forge | neoforge | paper ) [flags]
-
-Examples:
-  mrpack-install server fabric --server-dir fabric-srv
-  mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
+  mrpack-install update [<version>] [flags]
 
 Flags:
-      --flavor-version string      Flavor version (default "latest")
-  -h, --help                       help for server
-      --minecraft-version string   Minecraft version (default "latest")
+      --backup-dir string   Backup directory path
+  -h, --help                help for update
 
 Global Flags:
       --dl-retries uint8     Retries when download fails (default 3)
@@ -90,7 +90,7 @@ Global Flags:
   -v, --verbose              Enable verbose output
 ```
 ## Install
-### Linux
+#### Linux
 ```sh
 # download
 curl -sSL -o "/tmp/mrpack-install" "https://github.com/nothub/mrpack-install/releases/latest/download/mrpack-install-linux"
@@ -99,3 +99,9 @@ sudo install -t "/usr/local/bin" "/tmp/mrpack-install"
 # run
 mrpack-install --help
 ```
+## Build
+To build a release, run:
+```sh
+goreleaser healthcheck
+goreleaser release --auto-snapshot --clean
+```

tools/readme.sh → scripts/readme.sh

@@ -1,8 +1,4 @@
-#!/usr/bin/env nix-shell
-#! nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/f8e2ebd66d097614d51a56a755450d4ae1632df1.tar.gz
-#! nix-shell -p go_1_22
-#! nix-shell -i sh --pure
-# shellcheck shell=sh
+#!/usr/bin/env sh
 
 set -eu
 cd "$(dirname "$(realpath "$0")")/.."
@@ -26,18 +22,18 @@ echo "\`\`\`" >>README.md
 ./out/mrpack-install --help >>README.md
 echo "\`\`\`" >>README.md
 
-echo "#### modpack update" >>README.md
+echo "#### plain server deployment" >>README.md
 echo "\`\`\`" >>README.md
-./out/mrpack-install update --help >>README.md
+./out/mrpack-install server --help >>README.md
 echo "\`\`\`" >>README.md
 
-echo "#### plain server deployment" >>README.md
+echo "#### modpack update" >>README.md
 echo "\`\`\`" >>README.md
-./out/mrpack-install server --help >>README.md
+./out/mrpack-install update --help >>README.md
 echo "\`\`\`" >>README.md
 
 echo "## Install" >>README.md
-echo "### Linux" >>README.md
+echo "#### Linux" >>README.md
 echo "\`\`\`sh" >>README.md
 echo "# download" >>README.md
 echo "curl -sSL -o \"/tmp/mrpack-install\" \"https://github.com/nothub/mrpack-install/releases/latest/download/mrpack-install-linux\"" >>README.md
@@ -46,3 +42,10 @@ echo "sudo install -t \"/usr/local/bin\" \"/tmp/mrpack-install\"" >>README.md
 echo "# run" >>README.md
 echo "mrpack-install --help" >>README.md
 echo "\`\`\`" >>README.md
+
+echo "## Build" >>README.md
+echo "To build a release, run:" >>README.md
+echo "\`\`\`sh" >>README.md
+echo "goreleaser healthcheck" >>README.md
+echo "goreleaser release --auto-snapshot --clean" >>README.md
+echo "\`\`\`" >>README.md