# mini-os

**Repository Path**: haochengxie/mini-os

## Basic Information

- **Project Name**: mini-os
- **Description**: Fork from "https://github.com/rikeyone/mini-os"
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-08
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Description

MiniOS is a develop environment for linux kernel and applications using QEMU virtual machine. Developers can easily clone it and develop based on it. You can make your idea to an product very quickly using MiniOS environment. It is a good choice to verify your solutions on MiniOS before production.

# Install Environment

```
sudo ./install.sh
```
It will install compile toolchains of arm and arm64, and qemu environment.

# Build MiniOS

To build MiniOS system:

```
./build.sh [-a][-m module][-p platform]
```
Options:

```
 -a: build all modules.
 -m: build expect module:kernel/rootfs/busybox/libc/initramfs.
 -p: build platform, support arm and arm64, default is arm64.
 -h: help informations.
```

# Build Samples

 - Default platform arm64:

To build full MiniOS system [platform: arm64]:

```
./build.sh -a
```

To build MiniOS modules [platform:arm64]:

```
./build.sh -m {MODDULE}
```

the module has these values to choose: kernel, rootfs, busybox, libc, initramfs.
BTW, the rootfs module will include "libc", "initramfs" and "busybox" build.

eg:

```
./build.sh -m rootfs    #compile arm64 platform rootfs module
./build.sh -m kernel    #compile arm64 platform kernel module
```
 - arm platform

To build full MiniOS system [platform: arm]:

```
./build.sh -a -p arm
```

To build MiniOS modules [platform:arm]:

```
./build.sh -m {MODDULE} -p arm
```

the module has these values to choose: kernel, rootfs, busybox, libc, initramfs.
BTW, the rootfs module will include "libc", "initramfs" and "busybox" build.

eg:

```
./build.sh -m rootfs -p arm  #compile arm64 platform rootfs module
./build.sh -m kernel -p arm  #compile arm64 platform kernel module
```

# Run MiniOS

```
sudo ./run.sh
```
This command will run default arm64 minios system. If you build an arm platform minios,
you should add option to tell run.sh script:

```
sudo ./run.sh -p arm
```

# Stop MiniOS

```
sudo ./run.sh -s
```
This command will stop default arm64 minios system. If you want to stop an arm platform minios,
you should add option to tell run.sh script:

```
sudo ./run.sh -s -p arm
```
There is another important feature of minios, it support NFS as rootfs to boot linux kernel.
Using this feature, we can easily debug our applications without rebuilding the whole system:
```
sudo ./run.sh -t nfs -p arm
```
or
```
sudo ./run.sh -t nfs
```
# Advance Info

MiniOS kernel support list: linux-4.0/linux-4.9.

MiniOS busybox support list: busybox-1.24.0/busybox-1.30.0.

If you want to build the specific versions of kernel or busybox, just export env variables
to change kernel and busybox version to build, such as:

```
export BUSYBOX=busybox-1.30.0
export LINUX_KERNEL=linux-4.0
```
If no env variable is exported, the script will use default versions to build.