Skip to content
Shiro - Operating System
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
install
src
.gitignore
Dockerfile
changelog.md
docker-compose.yml
makefile
readme.md

readme.md

Shiro - Operating System (OS)

Shiro - Operating System (OS)
Version   Version

How to get started?

If you are using windows, make sure all files are LF instead of CRLF.

You can disable CRLF on Git by doing (optional):

$ git config --global core.safecrlf false
$ git config --global core.autocrlf false

To clone the project:

$ git clone git@github.com:shiro-dev/shiro.git

Requirements

Windows

QEMU emulator version 3.1.50+

Docker version 18.03.0-ce+

Docker Compose version 1.20.1+

Ubuntu (not tested)

QEMU emulator version 2.1.2+

$ apt-get update -y
$ apt-get install -y qemu

Docker

$ sudo apt-get update -y
$ sudo apt-get install docker-ce
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

If you need to set-up docker repository, please refer to docker documentation.

Docker Compose

$ sudo apt-get update -y
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

Build Environment

This command will build the development environment on docker.

$ make docker-build

Run Shiro

This command will build/rebuild the OS on docker and will run it using QEMU.

$ make run

Special Thanks

You can’t perform that action at this time.