From 0cf3e438a4f033a2f3ba5d9e89c5342e6a483f1b Mon Sep 17 00:00:00 2001
From: Michal Sojka <sojkam1@fel.cvut.cz>
Date: Wed, 17 Oct 2007 16:17:00 +0000
Subject: [PATCH] Domumentation updates.

darcs-hash:20071017161722-f2ef6-2e1cbf368c0ad860ffb146d869687a92e96e686c.gz
---
 doc/manual.texinfo | 67 +++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 60 insertions(+), 7 deletions(-)

diff --git a/doc/manual.texinfo b/doc/manual.texinfo
index 6252477..f8ececd 100644
--- a/doc/manual.texinfo
+++ b/doc/manual.texinfo
@@ -33,12 +33,63 @@ Copyright @copyright{} 2007 Michal Sojka, Pavel Pisa
 
 OMK is an advanced make system written entirely in GNU make. Compiling
 software using OMK requires only GNU make binary and standard UNIX
-utilities installed. OMK aims to be developer friendly; to use OMK,
-you do not need to understand (sometiles) cryptic syntax of makefile
-commands.
+utilities (@command{sh}, @command{sed} and
+@command{tr}@footnote{@command{tr} is needed only for OMK to be
+compatible with MinGW.}) installed. OMK aims to be developer friendly; to
+use OMK, you do not need to understand (sometimes) cryptic syntax of
+makefile commands.
+
+OMK handles properly dependencies of source files and libraries, so it
+is not necessary to recompile the whole project if only some files are
+changed. Also OMK greatly simplifies compilation of projects, where
+source files are spread between multiple directories. It is also very
+useful in combining components (libraries) from different projects to a
+single project.
+
+You can use OMK on all platforms where you can run GNU Make including
+Cygwin and MinGW. MS DOS was not tested.
+
+@c @section Features
+
+@c @itemize
+@c @item
+@c Easy to use for beginners.
+@c @item
+@c Automatic handling of dependencies.
+@c @item
+@c Supported host platforms: all Un*x operating system including Linux,
+@c Cygwin, MS DOS and maybe others.
+@c @end itemize
 
 @section Quick Start
 
+If you get some sources, which are distributed with OMK, usually the
+following commands are sufficient to compile the whole project.
+
+@example
+@verbatim
+make default-config
+make
+@end verbatim
+@end example
+
+To use OMK in your own project, follow these steps:
+
+@enumerate
+@item
+  Take appropriate @file{Makefile.rules}, put it together with leaf
+  @file{Makefile} to the root directory of your project.
+@item
+  Create @file{Makefile.omk} files in all directories you want to
+  compile something. Please refer to chapter ... to learn what to write
+  in @file{Makefile.omk} files.
+@item
+  Run @command{make omkize} in the root directory.
+@end enumerate
+
+Your project is now ready to compile.
+
+
 @node History
 @section History
 
@@ -49,9 +100,9 @@ package. Although this system was not accepted for the whole OCERA
 project. Several individual developers (mostly from Czech Technical
 University) liked it and started to use it.
 
-As number of users grew it was necessary to modularize the make system
-to support more ``targets''. Michal Sojka took care about the process
-of modularization.
+As a number of projects using OMK grew it was necessary to modularize
+the make system to support more ``targets''. Michal Sojka took care
+about the process of modularization.
 
 @chapter Original README
 
@@ -362,7 +413,7 @@ from all @code{default_CONFIG} lines in all @file{Makefile.omk}.  The
 file should be used for building of own @file{config.omk} file, or as
 list for all options if Kconfig is used.
 
-@chapter OMK User Manual
+@chapter OMK User's Manual
 
 @section Basic Concepts
 
@@ -374,6 +425,8 @@ list for all options if Kconfig is used.
 
 @section Configuration and Conditional Compilation
 
+@section Running OMK under Windows OS
+
 @chapter OMK Reference
 
 @chapter OMK Development
-- 
2.39.2