aboutsummaryrefslogtreecommitdiff
path: root/README.end.e.md
diff options
context:
space:
mode:
authorTong Sun <[email protected]>2023-05-02 23:40:39 -0400
committerTong Sun <[email protected]>2023-05-02 23:40:39 -0400
commit09f5064b46a7d1b5b2c793a434c84712bb8278d4 (patch)
treea61f9457ee8df75aab291942b5ba9ae2acd7d162 /README.end.e.md
parent- [#] prepare for separated README (diff)
downloadhtml2md-09f5064b46a7d1b5b2c793a434c84712bb8278d4.tar.xz
html2md-09f5064b46a7d1b5b2c793a434c84712bb8278d4.zip
- [+] add all-contributors initial settings & separated READMEs
Diffstat (limited to 'README.end.e.md')
-rw-r--r--README.end.e.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/README.end.e.md b/README.end.e.md
new file mode 100644
index 0000000..3d769ad
--- /dev/null
+++ b/README.end.e.md
@@ -0,0 +1,71 @@
+
+## Download/install binaries
+
+- The latest binary executables are available
+as the result of the Continuous-Integration (CI) process.
+- I.e., they are built automatically right from the source code at every git release by [GitHub Actions](https://docs.github.com/en/actions).
+- There are two ways to get/install such binary executables
+ * Using the **binary executables** directly, or
+ * Using **packages** for your distro
+
+### The binary executables
+
+- The latest binary executables are directly available under
+https://github.com/{{.User}}/{{.Name}}/releases/latest
+- Pick & choose the one that suits your OS and its architecture. E.g., for Linux, it would be the `{{.Name}}_verxx_linux_amd64.tar.gz` file.
+- Available OS for binary executables are
+ * Linux
+ * Mac OS (darwin)
+ * Windows
+- If your OS and its architecture is not available in the download list, please let me know and I'll add it.
+- The manual installation is just to unpack it and move/copy the binary executable to somewhere in `PATH`. For example,
+
+``` sh
+tar -xvf {{.Name}}_*_linux_amd64.tar.gz
+sudo mv -v {{.Name}}_*_linux_amd64/{{.Name}} /usr/local/bin/
+rmdir -v {{.Name}}_*_linux_amd64
+```
+
+
+### Distro package
+
+- [Packages available for Linux distros](https://cloudsmith.io/~suntong/repos/repo/packages/) are
+ * [Alpine Linux](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-alpine)
+ * [Debian](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-deb)
+ * [RedHat](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-rpm)
+
+The repo setup instruction url has been given above.
+For example, for [Debian](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-deb) --
+
+### Debian package
+
+
+```sh
+curl -1sLf \
+ 'https://dl.cloudsmith.io/public/suntong/repo/setup.deb.sh' \
+ | sudo -E bash
+
+# That's it. You then can do your normal operations, like
+
+sudo apt-get update
+apt-cache policy {{.Name}}
+
+sudo apt-get install -y {{.Name}}
+```
+
+## Install Source
+
+To install the source code instead:
+
+```
+go install {{.ProjectURL}}
+```
+
+## Author
+
+Tong SUN
+![suntong from cpan.org](https://img.shields.io/badge/suntong-%40cpan.org-lightgrey.svg "suntong from cpan.org")
+
+_Powered by_ [**WireFrame**](https://github.com/go-easygen/wireframe)
+[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-Y.svg)](http://godoc.org/github.com/go-easygen/wireframe)
+the _one-stop wire-framing solution_ for Go cli based projects, from _init_ to _deploy_.