From 8fac92474adb88a1deca15a34b68b12658dfd5ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Lov=C3=A9n?= Date: Sun, 30 Jun 2019 09:35:14 +0200 Subject: [PATCH] Update readme for publishing --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d85c7a..29c8e6f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -#MITTOS64 +# MITTOS64 -##Building +This project is my attempt at a modern kernel. + +Differences from my earlier kernels include +- 64 bit +- symmetric multiprocessing +- docker-based build chain +- unit tests + +I meant to write very extensive documentation of the development process, but with two kids I have realized that will probably never happen, so now I'm releasing as is. + +Also take a look at [mittos64-old](https://github.com/thomasloven/mittos64-old/) which is a previous version of this that got a bit further (processes, c-library (JIT-patching of musl), ATA). + +## Building This project is set up to be built inside a Docker container. The container can be built by running the `d` script in the projects root directory - provided Docker is installed on your computer.