- [+] add all-contributors initial settings & separated READMEs

5 files changed, 146 insertions, 0 deletions

diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 0000000..d268a04
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,41 @@
+{
+  "files": [
+    "README.md",
+    "README.beg.e.md",
+    "README.end2.e.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "suntong",
+      "name": "suntong",
+      "avatar_url": "https://avatars.githubusercontent.com/u/422244?v=4",
+      "profile": "https://github.com/suntong",
+      "contributions": [
+        "code",
+        "ideas",
+        "design",
+        "data",
+        "test",
+        "bug",
+        "doc",
+        "blog",
+        "example",
+        "tutorial",
+        "tool",
+        "platform",
+        "review",
+        "question",
+        "maintenance",
+        "infra"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "cc2py2",
+  "projectOwner": "go-cc",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}
diff --git a/.gitignore b/.gitignore
index 24bab20..a8d4579 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
+.all-contributorsrc
 # Binaries for programs and plugins
 *.exe
 *.exe~
diff --git a/README.beg.e.md b/README.beg.e.md
new file mode 100644
index 0000000..2c124e0
--- /dev/null
+++ b/README.beg.e.md
@@ -0,0 +1,13 @@
+# {{.Name}}
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+{{render "license/shields" . "License" "MIT"}}
+{{template "badge/godoc" .}}
+{{template "badge/goreport" .}}
+[![Build Status](https://github.com/{{.User}}/{{.Name}}/actions/workflows/go-release-build.yml/badge.svg?branch=master)](https://github.com/{{.User}}/{{.Name}}/actions/workflows/go-release-build.yml)
+[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-B.svg)](http://godoc.org/github.com/go-easygen/wireframe)
+
+{{pkgdoc}}
+
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_.
diff --git a/README.end2.e.md b/README.end2.e.md
new file mode 100644
index 0000000..7f74ac6
--- /dev/null
+++ b/README.end2.e.md
@@ -0,0 +1,20 @@
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/suntong"><img src="https://avatars.githubusercontent.com/u/422244?v=4?s=100" width="100px;" alt=""/><br /><sub><b>suntong</b></sub></a><br /><a href="https://github.com/go-cc/cc2py2/commits?author=suntong" title="Code">💻</a> <a href="#ideas-suntong" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-suntong" title="Design">🎨</a> <a href="#data-suntong" title="Data">🔣</a> <a href="https://github.com/go-cc/cc2py2/commits?author=suntong" title="Tests">⚠️</a> <a href="https://github.com/go-cc/cc2py2/issues?q=author%3Asuntong" title="Bug reports">🐛</a> <a href="https://github.com/go-cc/cc2py2/commits?author=suntong" title="Documentation">📖</a> <a href="#blog-suntong" title="Blogposts">📝</a> <a href="#example-suntong" title="Examples">💡</a> <a href="#tutorial-suntong" title="Tutorials">✅</a> <a href="#tool-suntong" title="Tools">🔧</a> <a href="#platform-suntong" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/go-cc/cc2py2/pulls?q=is%3Apr+reviewed-by%3Asuntong" title="Reviewed Pull Requests">👀</a> <a href="#question-suntong" title="Answering Questions">💬</a> <a href="#maintenance-suntong" title="Maintenance">🚧</a> <a href="#infra-suntong" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!