-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
41 changed files
with
3,588 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [0.0.1] - 2021-11-14 | ||
## Added | ||
- mimixbox project. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Gopkg.toml example | ||
# | ||
# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html | ||
# for detailed Gopkg.toml documentation. | ||
# | ||
# required = ["github.com/user/thing/cmd/thing"] | ||
# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"] | ||
# | ||
# [[constraint]] | ||
# name = "github.com/user/project" | ||
# version = "1.0.0" | ||
# | ||
# [[constraint]] | ||
# name = "github.com/user/project2" | ||
# branch = "dev" | ||
# source = "github.com/myfork/project2" | ||
# | ||
# [[override]] | ||
# name = "github.com/x/y" | ||
# version = "2.4.0" | ||
# | ||
# [prune] | ||
# non-go = false | ||
# go-tests = true | ||
# unused-packages = true | ||
|
||
|
||
[prune] | ||
go-tests = true | ||
unused-packages = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
build: deps | ||
go build -o mimixbox cmd/mimixbox/main.go | ||
$(MAKE) doc | ||
|
||
clean: | ||
-rm mimixbox | ||
-rm -rf vendor | ||
-rm cover.* | ||
-rm -rf release | ||
-find . -name "*.1.gz" | xargs rm -f | ||
|
||
doc: | ||
./scripts/mkManpages.sh | ||
|
||
install: | ||
./scripts/installer.sh | ||
|
||
release: | ||
./scripts/release.sh | ||
|
||
deps: | ||
dep ensure | ||
go mod vendor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * | ||
1. The MimixBox project copyright: | ||
|
||
Copyright 2021 Naohiro CHIKAMATSU | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * | ||
2. The fakemovie(cmd/fakemovie/main.go) was forked from fakemovie project: | ||
"https://github.com/mattn/fakemovie". | ||
The fakemovie is a dual license with MIT license (original source code only) | ||
and Apache license Version 2.0 (Only the part modified source code from the | ||
forked one). | ||
|
||
MIT License (for original source code) | ||
|
||
Copyright 2020 Yasuhiro Matsumoto (a.k.a. mattn) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
----- | ||
|
||
The changelist from the original fakemovie are shown below. | ||
- Semantic Versioning | ||
- run() : Move the main process from main() to run() | ||
- parseArgs() : Argument parsing function | ||
- initParser() : Parser initialization function | ||
- isValidArgNr(): Function to check if the number of arguments is correct | ||
- isValidExt() : Function to check if image file extension is correct | ||
- showVersion() : Function to show fakemovie version | ||
- showHelp() : Function to show help message | ||
- openImage() : Function to open image file | ||
- writeImage() : Function to write image file | ||
- putBlueBtn() : Rename Fake() to putBlueBtn() | ||
- addOrangeBtn(): Function to add orange button to the image | ||
- decideOutputFileName() : Function that make string with "original file name" + "_fake" + "extension" | ||
- extractFileNameWithoutExt(): Function that return filename without extension. | ||
|
||
The above code is the copyright below. | ||
|
||
Copyright 2021 Naohiro CHIKAMATSU | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# MimixBox - mimic BusyBox on Linux | ||
MimixBox has many Unix commands in the single binary like BusyBox. However, mimixbox aim for the different uses from BusyBox. Specifically, it is supposed to be used in the desktop environment, not the embedded environment. | ||
Also, the mimixbox project maintainer plan to have a wide range of built-in commands (applets) from basic command provided by Coreutils and others to experimental commands. | ||
|
||
# Installation. | ||
The source code and binaries are distributed on the Release Page in ZIP format or 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 commands on your system with the following command: | ||
|
||
``` | ||
$ tar xf mimixbox-0.0.1-linux-arm64.tar.gz | ||
$ cd mimixbox-0.0.1-linux-arm64 | ||
$ sudo ./installer.sh | ||
``` | ||
|
||
# Development (How to build) | ||
If you want to contribute to the mimixbox project, get the source code with the following command. | ||
``` | ||
$ git clone https://github.com/nao1215/mimixbox.git | ||
$ cd mimixbox | ||
$ make | ||
``` | ||
|
||
The table below shows the tools used when developing the commands in the mimixbox project. | ||
| Tool | description | | ||
|:-----|:------| | ||
| dep | Used for managing dependencies for Go projects| | ||
| gobump | Used for command version control | | ||
| go-licenses | Used for license management of dependent libraries| | ||
| pandoc | Convert markdown files to manpages | | ||
| make | Used for build, run, test, etc | | ||
| gzip | Used for compress man pages | | ||
| install | Used for install serial binary and document in the system | | ||
|
||
# Contact | ||
If you would like to send comments such as "find a bug" or "request for additional features" to the developer, please use one of the following contacts. | ||
|
||
- [GitHub Issue](https://github.com/nao1215/mimixbox/issues) | ||
- [mail@Naohiro CHIKAMATSU]([email protected]) | ||
- [Twitter@ARC_AED](https://twitter.com/ARC_AED) | ||
|
||
# LICENSE | ||
The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0. | ||
See [LICENSE](./LICENSE) and [NOTICE](./NOTICE) |
Oops, something went wrong.