README

Nupkux Distribution README file

----------Description

Nupkux is a try to create a Unix-alike kernel with some basic userspace
applications running on it. Its name is derived from "Nur plia kripla unikso,"
Esperanto for "Just another stunted Unix." There is no will to reach this aim,
it is just a way of learning how computers and Unix-Systems work "under the
hood." 

----------Contents

There are tree main parts in this package:
	- Nupkux, the kernel (./src)
	- Userspace Applications and a small libc (./usr)
	- Tools related to Nupkux, help to build it (./tools)

----------Dependencies

I'm using Debian GNU/Linux for developing, compiling and testing.
You will need a Linux distribution, since you've got to use "mount -o loop"
Further needed:
	- gcc (>=4.X)
	- GNU make
	- makedepend (from xutils-dev)
	- git for archiving

----------Compiling

Change into this directory and type:

	$ make

To customize the building process modify the not well documented Makefiles

----------Installing

Nupkux is pre-alpha software, which can be very harmful to your computer. 	
I recommend you to use a virtual machine for testing purposes, there is 
ANY WARRANTY for damage caused by Nupkux.
Good virtual machines:
	- Qemu (http://bellard.org/qemu)
	- VirtualBox (http://www.virtualbox.org)
	- Bochs (http://bochs.sourceforge.net)

By default Nupkux is not going to be installed on your real hard drive.
If you type as superuser:

	# make install

Nupkux and its userspace applications will be installed on a virtual
floppy drive. Mounting this drive requires superuser-rights (root, sudo).

You will need an image of this floppy, which can be found at:

	http://prdownload.berlios.de/nupkux/bootdisk.img.gz

Qemu users can type:

	# make all install run_qemu
	
----------License

Nupkux comes under the GNU General Public License (GPL) version 3, as published
by the Free Software Foundation. You can find a copy at ./src/COPYING .
How ever, there are some parts, not written by me under other licenses,
often highly modified and not in a clear state of copyright.
Some of them are marked so, others not. I'm really sorry for this and hope
to line out the foreign parts soon.

Stay up to date: https://github.com/tzwenn/nupkux
Aug 2008	Sven Köhler