From 3de134a3f0930ade039a3975df71d12cc7ded815 Mon Sep 17 00:00:00 2001 From: Jonas 'Sortie' Termansen Date: Sun, 11 Mar 2012 01:42:03 +0100 Subject: [PATCH] Added build instructions to the README. --- README | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README b/README index a581e71a..f8405543 100644 --- a/README +++ b/README @@ -72,6 +72,28 @@ Executable files natively uses the ELF format used on GNU/Linux and other systems. There is no shared library support yet, but it'll be possible when I get around to implement copy-on-write memory, mmap(2) and swapping to disk. +Building +-------- +To build the Sortix source code you need to install a few dependencies. First of +all you need the GNU Compiler Collection (C and C++), GNU Make, and GNU +Binutils. You then need to build and install the included macro preprocessor +mxmpp somewhere in your PATH such as /usr/bin. If you wish to build the 32-bit +version of Sortix, you need the Netwide Assembler (nasm) as parts of it hasn't +been ported to the GNU assembler yet. You need a GNU/Linux build system to build +Sortix, although, it wouldn't be difficult to port the build system to other +platforms. You can then build the Sortix kernel and user-space utilities by +running make in the Sortix root source directory. By default it will build to +your CPU architecture (64-bit on 64-bit systems, 32-bit otherwise). Use +CPU=x86 or CPU=x64 as arguments to make to control which target is built. + +To build a bootable ISO you need GNU GRUB 2, as that is used by "make iso" to +generate the iso. In turn, GNU GRUB relies on xorriso to create the iso file. + +You can burn the ISO to a cdrom or dvd, or even dd(1) it onto a USB memory stick +and boot from if it your BIOS supports it. You can also provide it to a virtual +machine. Alternatively you can install the kernel binary and initrd in your +/boot directory and configure GRUB to boot Sortix. + Links ----- You can visit the official website at http://www.maxsi.org/software/sortix/ for @@ -84,7 +106,8 @@ https://gitorious.org/sortix/. License ------- -Copyright(C) Jonas 'Sortie' Termansen and contributors 2011, 2012. +Copyright(C) Jonas 'Sortie' Termansen and contributors 2011, +2012. The Sortix kernel, the filesystem servers, the initrd tools, the utilities, the games, and the benchmark programs are licensed under the GNU General Public