Skip to content

Commit 09f5064

Browse files
suntongsuntong
committed
- [+] add all-contributors initial settings & separated READMEs
1 parent 094a514 commit 09f5064

5 files changed

Lines changed: 146 additions & 0 deletions

File tree

‎.all-contributorsrc‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"files": [
3+
"README.md",
4+
"README.beg.e.md",
5+
"README.end2.e.md"
6+
],
7+
"imageSize": 100,
8+
"commit": false,
9+
"contributors": [
10+
{
11+
"login": "suntong",
12+
"name": "suntong",
13+
"avatar_url": "https://avatars.githubusercontent.com/u/422244?v=4",
14+
"profile": "https://github.com/suntong",
15+
"contributions": [
16+
"code",
17+
"ideas",
18+
"design",
19+
"data",
20+
"test",
21+
"bug",
22+
"doc",
23+
"blog",
24+
"example",
25+
"tutorial",
26+
"tool",
27+
"platform",
28+
"review",
29+
"question",
30+
"maintenance",
31+
"infra"
32+
]
33+
}
34+
],
35+
"contributorsPerLine": 7,
36+
"projectName": "cc2py2",
37+
"projectOwner": "go-cc",
38+
"repoType": "github",
39+
"repoHost": "https://github.com",
40+
"skipCi": true
41+
}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.all-contributorsrc
12
# Binaries for programs and plugins
23
*.exe
34
*.exe~

‎README.beg.e.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# {{.Name}}
2+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
4+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5+
6+
{{render "license/shields" . "License" "MIT"}}
7+
{{template "badge/godoc" .}}
8+
{{template "badge/goreport" .}}
9+
[![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)
10+
[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-B.svg)](http://godoc.org/github.com/go-easygen/wireframe)
11+
12+
{{pkgdoc}}
13+

‎README.end.e.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
2+
## Download/install binaries
3+
4+
- The latest binary executables are available
5+
as the result of the Continuous-Integration (CI) process.
6+
- I.e., they are built automatically right from the source code at every git release by [GitHub Actions](https://docs.github.com/en/actions).
7+
- There are two ways to get/install such binary executables
8+
* Using the **binary executables** directly, or
9+
* Using **packages** for your distro
10+
11+
### The binary executables
12+
13+
- The latest binary executables are directly available under
14+
https://github.com/{{.User}}/{{.Name}}/releases/latest
15+
- 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.
16+
- Available OS for binary executables are
17+
* Linux
18+
* Mac OS (darwin)
19+
* Windows
20+
- If your OS and its architecture is not available in the download list, please let me know and I'll add it.
21+
- The manual installation is just to unpack it and move/copy the binary executable to somewhere in `PATH`. For example,
22+
23+
``` sh
24+
tar -xvf {{.Name}}_*_linux_amd64.tar.gz
25+
sudo mv -v {{.Name}}_*_linux_amd64/{{.Name}} /usr/local/bin/
26+
rmdir -v {{.Name}}_*_linux_amd64
27+
```
28+
29+
30+
### Distro package
31+
32+
- [Packages available for Linux distros](https://cloudsmith.io/~suntong/repos/repo/packages/) are
33+
* [Alpine Linux](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-alpine)
34+
* [Debian](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-deb)
35+
* [RedHat](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-rpm)
36+
37+
The repo setup instruction url has been given above.
38+
For example, for [Debian](https://cloudsmith.io/~suntong/repos/repo/setup/#formats-deb) --
39+
40+
### Debian package
41+
42+
43+
```sh
44+
curl -1sLf \
45+
'https://dl.cloudsmith.io/public/suntong/repo/setup.deb.sh' \
46+
| sudo -E bash
47+
48+
# That's it. You then can do your normal operations, like
49+
50+
sudo apt-get update
51+
apt-cache policy {{.Name}}
52+
53+
sudo apt-get install -y {{.Name}}
54+
```
55+
56+
## Install Source
57+
58+
To install the source code instead:
59+
60+
```
61+
go install {{.ProjectURL}}
62+
```
63+
64+
## Author
65+
66+
Tong SUN
67+
![suntong from cpan.org](https://img.shields.io/badge/suntong-%40cpan.org-lightgrey.svg "suntong from cpan.org")
68+
69+
_Powered by_ [**WireFrame**](https://github.com/go-easygen/wireframe)
70+
[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-Y.svg)](http://godoc.org/github.com/go-easygen/wireframe)
71+
the _one-stop wire-framing solution_ for Go cli based projects, from _init_ to _deploy_.

‎README.end2.e.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
## Contributors ✨
3+
4+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
5+
6+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
7+
<!-- prettier-ignore-start -->
8+
<!-- markdownlint-disable -->
9+
<table>
10+
<tr>
11+
<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>
12+
</tr>
13+
</table>
14+
15+
<!-- markdownlint-restore -->
16+
<!-- prettier-ignore-end -->
17+
18+
<!-- ALL-CONTRIBUTORS-LIST:END -->
19+
20+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)