install guide in readme

nothub · Nov 1, 2023 · c73c75d · c73c75d
1 parent 19cc5b0
commit c73c75d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 16 deletions.
diff --git a/Makefile b/Makefile
@@ -34,30 +34,33 @@ dl-stats:
 
 README.md: out/$(BIN_NAME)
 	@echo "# $(BIN_NAME)" > README.md
-	@echo "" >> README.md
 	@echo "[![downloads](https://img.shields.io/github/downloads/nothub/mrpack-install/total.svg?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://github.com/nothub/mrpack-install/releases/latest)" >> README.md
 	@echo "[![discord](https://img.shields.io/discord/1149744662131777546?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://discord.gg/QNbTeGHBRm)" >> README.md
 	@echo "[![go pkg](https://pkg.go.dev/badge/github.com/nothub/mrpack-install.svg)](https://pkg.go.dev/github.com/nothub/mrpack-install)" >> README.md
 	@echo "" >> README.md
 	@echo "A cli application for installing Minecraft servers and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/)." >> README.md
 	@echo "" >> README.md
 	@echo "---" >> README.md
-	@echo "" >> README.md
+	@echo "## Usage" >> README.md
 	@echo "#### modpack deployment" >> README.md
 	@echo "\`\`\`" >> README.md
 	./out/mrpack-install --help >> README.md
 	@echo "\`\`\`" >> README.md
-	@echo "" >> README.md
-	@echo "---" >> README.md
-	@echo "" >> README.md
 	@echo "#### modpack update" >> README.md
 	@echo "\`\`\`" >> README.md
 	./out/mrpack-install update --help >> README.md
 	@echo "\`\`\`" >> README.md
-	@echo "" >> README.md
-	@echo "---" >> README.md
-	@echo "" >> README.md
 	@echo "#### plain server deployment" >> README.md
 	@echo "\`\`\`" >> README.md
 	./out/mrpack-install server --help >> README.md
 	@echo "\`\`\`" >> README.md
+	@echo "## Install" >> 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/download/$(VERSION)/mrpack-install-linux\"" >> README.md
+	@echo "# install to a place in PATH" >> README.md
+	@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
diff --git a/README.md b/README.md
@@ -1,13 +1,12 @@
 # mrpack-install
-
 [![downloads](https://img.shields.io/github/downloads/nothub/mrpack-install/total.svg?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://github.com/nothub/mrpack-install/releases/latest)
 [![discord](https://img.shields.io/discord/1149744662131777546?style=flat-square&labelColor=5c5c5c&color=007D9C)](https://discord.gg/QNbTeGHBRm)
 [![go pkg](https://pkg.go.dev/badge/github.com/nothub/mrpack-install.svg)](https://pkg.go.dev/github.com/nothub/mrpack-install)
 
 A cli application for installing Minecraft servers and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/).
 
 ---
-
+## Usage
 #### modpack deployment
 ```
 Deploys a Modrinth modpack including Minecraft server.
@@ -45,9 +44,6 @@ Flags:
 
 Use "mrpack-install [command] --help" for more information about a command.
 ```
-
----
-
 #### modpack update
 ```
 Update the deployed modpacks files, creating backups if necessary.
@@ -68,9 +64,6 @@ Global Flags:
       --server-file string   Server jar file name
   -v, --verbose              Enable verbose output
 ```
-
----
-
 #### plain server deployment
 ```
 Download and configure one of several Minecraft server flavors.
@@ -96,3 +89,13 @@ Global Flags:
       --server-file string   Server jar file name
   -v, --verbose              Enable verbose output
 ```
+## Install
+### Linux
+```sh
+# download
+curl -sSL -o "/tmp/mrpack-install" "https://github.com/nothub/mrpack-install/releases/download/v0.16.4/mrpack-install-linux"
+# install to a place in PATH
+sudo install -t "/usr/local/bin" "/tmp/mrpack-install"
+# run
+mrpack-install --help
+```