From e9a4d68963f1ef65d265b5628f9f178215474710 Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Wed, 1 May 2024 22:26:16 +0900 Subject: [PATCH] docs: add @nao1215 as a contributor --- .all-contributorsrc | 25 +++++++++++++++++++++++++ README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 2 files changed, 63 insertions(+), 4 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..7592260 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,25 @@ +{ + "projectName": "mimixbox", + "projectOwner": "nao1215", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 75, + "commit": true, + "commitConvention": "angular", + "contributors": [ + { + "login": "nao1215", + "name": "CHIKAMATSU Naohiro", + "avatar_url": "https://avatars.githubusercontent.com/u/22737008?v=4", + "profile": "https://debimate.jp/", + "contributions": [ + "code" + ] + } + ], + "contributorsPerLine": 7, + "linkToUsage": true +} diff --git a/README.md b/README.md index bba3961..1e87642 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@
+ +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +
@@ -19,18 +22,18 @@ Also, the MimixBox project maintainer plan to have a wide range of built-in comm The source code and binaries are distributed on [the Release Page](https://github.com/nao1215/mimixbox/releases) in ZIP format and tar.gz format. Choose the binary that suits your OS and CPU architecture. For example, in the case of Linux (amd64), you can install the MimixBox and documents on your system with the following command: -``` +```shell $ tar xf mimixbox-0.30.0-linux-amd64.tar.gz $ cd mimixbox-0.30.0-linux-amd64 $ sudo ./installer.sh ``` -If you have a Golang development environment, you can also install it by the following method. This method does not install the documentation. - -``` +## Use "go install" +```shell $ go install github.com/nao1215/mimixbox/cmd/mimixbox@latest $ sudo mimixbox --install /usr/local/bin ``` + # Development ## Tools & Libraries The table below shows the tools used when developing the commands in the MimixBox project. @@ -118,3 +121,34 @@ We are also looking forward to sponsorship. # LICENSE The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE) + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + +
CHIKAMATSU Naohiro
CHIKAMATSU Naohiro

💻
+ + Add your contributions + +
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file