install guide in readme

nothub · Nov 1, 2023 · ea491b4 · ea491b4
1 parent d9f2f24
commit ea491b4
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 22 deletions.
diff --git a/Makefile b/Makefile
@@ -32,28 +32,31 @@ check:
 
 README.md: out/$(BIN_NAME)
 	@echo "# $(BIN_NAME)" > README.md
-	@echo "" >> README.md
 	@echo "[![Go Reference](https://pkg.go.dev/badge/$(MOD_NAME).svg)](https://pkg.go.dev/$(MOD_NAME))" >> 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 "#### modpack deployment" >> 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 "### 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 "### 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,12 +1,11 @@
 # mrpack-install
-
 [![Go Reference](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/).
 
 ---
-
-#### modpack deployment
+## Usage
+### modpack deployment
 ```
 Deploys a Modrinth modpack including Minecraft server.
 
@@ -42,10 +41,7 @@ Flags:
 
 Use "mrpack-install [command] --help" for more information about a command.
 ```
-
----
-
-#### modpack update
+### modpack update
 ```
 Update the deployed modpacks config and mod files, creating backup files if necessary.
 
@@ -63,10 +59,7 @@ Global Flags:
       --server-dir string      Server directory path (default "mc")
       --server-file string     Server jar file name
 ```
-
----
-
-#### plain server deployment
+### plain server deployment
 ```
 Download and configure one of several Minecraft server flavors.
 
@@ -90,3 +83,13 @@ Global Flags:
       --server-dir string      Server directory path (default "mc")
       --server-file string     Server jar file name
 ```
+## Install
+### Linux
+```sh
+# download
+curl -sSL -o "/tmp/mrpack-install" "https://github.com/nothub/mrpack-install/releases/download/v0.16.9/mrpack-install-linux"
+# install to a place in PATH
+sudo install -t "/usr/local/bin" "/tmp/mrpack-install"
+# run
+mrpack-install --help
+```