Skip to content

Latest commit

 

History

History
87 lines (72 loc) · 4.37 KB

README.md

File metadata and controls

87 lines (72 loc) · 4.37 KB
Raw

Build

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 build

The table below shows the tools used when developing the commands in the mimixbox project.

Tool description
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
docker Used for testing Mimixbox inside Docker
debootstrap Used for testing Mimixbox inside jail envrioment

Debugging

How to create docker(testing) environment

# sudo apt install docker.io  ※ If you have not installed Docker in Ubuntu.
$ make docker

(注釈) Once the Docker image build is complete, you'll be inside the container.
$

How to create jail(testing) environment

$ sudo apt install debootstrap    ※ If you have not installed debootstrap in Ubuntu.
$ make build                      ※ Build mimixbox binary
$ sudo make jail                  ※ Create jail environment at /tmp/mimixbox/jail

$ sudo chroot /tmp/mimixbox/jail /bin/bash   ※ Dive to jail
# mimixbox --full-install /usr/local/bin     ※ Install MimixBox's command in jail

Roadmap

  • Step1. Implements many common Unix commands (〜Version 0.x.x).
  • Step2. Increase the options for each commands (〜Version 1.x.x).
  • Step3. Change the command to modern specifications(〜Version 2.x.x)

Now, Mimixbox has not implemented enough commands (currently supported command list is here). Therefore, as a project, we will increase the number of commands and aim for a state where dog fooding can be done with the highest priority.

Then increase the command options to the same level as Coreutils and other packages. Note that MimixBox does not aim to create commands equivalent to Coreutils. However, we think it's better to have the options that Linux users expect.

Finally, it's the phase that makes the Mimix Box unique. Extend commands to high functionality, like bat and lsd, which are reimplementations of cat and ls.

Original commands in MimixBox

MimixBox has its own commands that don't exist in packages like Coreutils.

Command (Applet) Name Description
fakemovie Adds a video playback button to the image
ghrdc GitHub Relase Download Counter
path Manipulate filename path
serial Rename the file to the name with a serial number

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.

LICENSE

The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0.
See LICENSE and NOTICE