Tkware Operating System
	=======================

	[... work in progress ...]		Tue, 14th Aug 2001


	Author contact information:
	---------------------------

	Thomas Kjoernes
	Blindjogata 5
	6600 Sunndalsoera
	NORWAY

	Phone: 	+47 41563212
	E-mail:	thomas_kjoernes@hotmail.com


	Updates to the OS are available from:
	-------------------------------------

		http://home.no.net/tkos/os.zip


	Minimum system requirements:
	----------------------------

	- IBM PC compatible, i386 CPU and 4MB RAM.


	Building the OS:
	----------------

	1. Unzip the stuff: 
		
		PKUNZIP os /d

		The full path for the SRC directory becomes .\os\src,
		you may want to rename OS to TKOS or similar.

	2. Setup the environment:

		Run the CFG.BAT file from os\build like this:

		c:\os\build\cfg c: os

		This sets up the path and some other variables.

	3. Make sure you have TASM, TLINK and TLINK32 in your path.

		This one you'll have to figure out yourself.

	4. Run the build batch file.

		build <ENTER>

	5. You should end up in the "bin" directory with a bunch of
	   files when build completes. Then type:

		loader <ENTER>

	   ... and the OS should start.	


	Directories:
	------------

	OK, here comes a short description of each base directory and 
	what you will find there.

	bin
	---

	The "binaries" directory is where all the stuff ends up once
	the tree is built. If the make.bat files don't copy the files
	being built to the bin directory they never end up here though.


	build
	-----

	Contains a bunch of batch files to help me build and maintain
	the source tree. The most useful ones are probably build.bat, 
	quick.bat, src.bat and bin.bat


	tools
	-----

	Contains a few useful utilities, such as DEBSYM, MZSHRINK and 
	PESHRINK.

	- DEBSYM is supposed to create a kernel debugger symbol file
	  named SYMBOLS.SYM with loads of information. Currently this 
	  file only contains the symbolic names for my API services.

	- MZSHRINK will remove wasted space in the header of "MZ" EXEs.

	- PESHRINK will truncate the file after the last section.


	zip
	---

	This is where the OS.ZIP file ends up when you run build.bat
	with the ZIP command line option:

		build zip


	Existing ZIP files are renamed OS.ZI1 - OS.ZI9 as they get
	older basically, useful for keeping track of old goodies or
	recovering from harddisk disasters.


	src
	---

	The source directory contains all the source code that make up
	the components of the operating system. 




	Future development:
	-------------------

	Moving on slowly, I'm stuck in the design phase.