diff --git a/README.md b/README.md new file mode 100644 index 0000000..50a7564 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +DeforaOS uKernel +================ + +About uKernel +------------- + +uKernel is intended to be the kernel of the DeforaOS Operating System. + +This project is in a very early stage and only targets the Intel 32-bit +architecture for the moment (x86). + + +Compiling uKernel +----------------- + +First, the Makefiles must be generated for the current platform. This can be +performed with `configure(1)` from the DeforaOS configure project, found at +. The procedure is then as +follows: +``` +$ configure +``` + +Please refer to the documentation of DeforaOS configure for further +instructions. + +Once this done, to build uKernel, simply run: +``` +$ make +``` + +The resulting kernel is located in src/uKernel.bin. It is meant to produce a +multiboot-compliant kernel file. + + +Testing uKernel +--------------- + +To test uKernel: +``` +$ qemu-system-i386 -nographic -kernel src/uKernel.bin +``` diff --git a/project.conf b/project.conf index 2318b20..8c08720 100644 --- a/project.conf +++ b/project.conf @@ -2,4 +2,4 @@ package=uKernel version=0.0.0 subdirs=src,tests -dist=COPYING,Makefile +dist=COPYING,Makefile,README.md