Changeset 1609

Timestamp:

Nov 5, 1999, 11:32:14 AM (26 years ago)

Author:

phaller

Message:

enhancements ;-)

File:

• trunk/Readme.txt (modified) (2 diffs)

trunk/Readme.txt

@@ -1 @@
-/* $Id: Readme.txt,v 1.6 1999-06-30 17:27:58 sandervl Exp $ */
+/* $Id: Readme.txt,v 1.7 1999-11-05 10:32:14 phaller Exp $ */
 
-39/06/99: Project Odin Source Code Notes
-========================================
+1999/11/05: Project Odin Source Code Notes
+==========================================
+
+1.0 Introduction
+----------------
+
+This readme is intended for making people more familiar with ODIN and to describe
+various aspects of the project such as accessing latest sources via cvs, building 
+the binaries, running win32 applications, how to identify and report problems and
+bugs, as well as how to acticely participate in this very promising project.
+
+19/06/99: Sander van Leeuwen (sandervl@xs4all.nl)
+99/11/05: Patrick Haller     (phaller@gmx.net)
+
+
+1.1 Prerequisites:
+------------------
 
 Required compilers/tools:
@@ -55 +70 @@
         - Source code style will be decided on in the near future.
 
-19/06/99: Sander van Leeuwen (sandervl@xs4all.nl)
+
+2.0 Accessing ODIN source code via CVS
+--------------------------------------
+
+Please check out http://www.netlabs.org/ and http://www.netlabs.org/odin. 
+
+
+3.0 Building the binaries
+-------------------------
+
+Basically, if your system setup meets above stated requirements, everything you need to
+do for a binary build is:
+
+  make debug
+
+or alternatively
+
+  make release
+
+As the current state of the project is still known to be alpha level, one should expect
+some functions not to work properly. Therefore, we recommend the use of the debug-version
+which creates long logfiles for problem determination purpose and to allow active debugging
+with debuggers such as IPMD, ICAT, KDB, etc.
+
+Please note if you do not want to suffer from the performance loss of writing logfiles, you
+can disable logging even with the debug binaries of ODIN by setting:
+
+  SET NOWIN32LOG=YES
+
+To enable logging again, clear this environment variable by typing:
+
+  SET NOWIN32LOG=
+
+
+3.1 Build problems
+------------------
+
+ODIN is moving at fast pace. Sometimes side effects of source dependencies may require you
+to do a full rebuild of the binaries instead of an incremental build.
+
+However, rarely it also happens the sources contained in the CVS repository do not build
+completely due to erroneous source code. Usually, this is fixed within two days at maximum.
+In such event, one can normally stick with the previous version of the particular module
+to further test win32 applications on ODIN.
+
+Please report such build problems through the appropriate channel.
+
+
+3.2 Downloading daily built binaries
+------------------------------------
+
+http://www.os2.org/ has setup a ftp server that hosts the automatically built binaries
+on daily basis. For people that do not have a suitable development setup for ODIN, we
+provide latest binary code that way.
+
+
+4.0 Running Win32 applications on ODIN
+--------------------------------------
+
+
+5.0 How to identify and report problems
+---------------------------------------
+
+
+5.1 Understanding the logfiles
+------------------------------
+
+
+5.2 Reporting a problem
+-----------------------
+
+
+6.0 Project participation
+-------------------------
+
+As ODIN became an open source project, everybody is kindly invited to contribute his share
+to the progress of the project. May it be active coding, fixing bugs or just providing
+detailed information about examined problems.
+
+We suggest you subscribe to win32os2-WAI and the corresponsing mailing lists on http://www.egroups.com.
+In case you are interested in participating, every member of the project will be happy
+to give you direction to the right places and to give a personal introduction to further
+development of the particular modules.
+
+