Updated README

diff --git a/README b/README
index 737e2ad98f6cb5490e8901066a8515415d97cc19..5ee3ff64bc417dc2653f2d2ce3e84bd50445b6b7 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,16 @@
 * FRSH/FORB FRAMEWORK
 
   FRSH/FORB is a contract-based resource reservation framework for
-  distributed real-time applications. It provides timing isolation
-  between applications, i.e. multiple applications can use the same
-  resources such as CPU, networks, etc., without influencing timing of
-  the other applications. The main principle is that application
-  developers use FRSH API to specify their resource requirements
-  needed to achieve desired timeliness and the framework uses
-  schedulability analysis to check these requirements. If the check is
-  successful an application is granted a "virtual resource" which
-  allow the application to use the requested resource while enforcing
-  the application not to use more than requested.
+  distributed real-time applications. In general, it provides timing
+  isolation between applications, i.e. multiple applications can use
+  the same resources such as CPU, networks, etc., without influencing
+  timing of the other applications. The main principle is that
+  application developers use FRSH API to specify their resource
+  requirements needed to achieve desired timeliness and the framework
+  uses schedulability analysis to check these requirements. If the
+  check is successful an application is granted a "virtual resource"
+  which allow the application to use the requested resource while
+  enforcing the application not to use more than requested.
 
   The development of the framework begun in FRESCOR project
   (http://frescor.org) and now it is developed as a stand-alone
@@ -23,28 +23,28 @@
    git submodule init
    git submodule update
 
-2) Until everything is converted to GIT, some pieces must be fetched
-   from FRESCOR SVN:
-
-   cd src
-   ./update-svn
-
-3) Go to build directory and configure the build:
+2) Go to build directory and configure the build:
    
-   cd ../build/aquosa
+   cd build/aquosa
    make default-config
 
    If you are not satisfied with configuration found in
    config.omk-default or config.target, you can override it in
    config.omk.
 
-4) Compile it:
+   To be able to use CPU reservations AQuoSA
+   (http://aquosa.sourceforge.net) has to be installed. If you cannot
+   use AQuoSA, the framework can also be compiled without CPU support
+   or can use cgroups. Note, that cgroups support is not well tested,
+   but we plan to work on it.
+
+3) Compile it:
 
    make
 
 
 
-* OLD HOWTO
+* OLD HOWTO - may be out of date
 
     Linux + AQuoSA
 
@@ -87,7 +87,7 @@
 
   make
 
-Further remarks
+** Further remarks
 
 - If we are not interested in compilation of some component (because
   it is currently in uncompilable state), we can simply delete the
@@ -116,7 +116,7 @@ Further remarks
 
   alias omk="make -f $HOME/frescor/src/omk-build/marte/Makefile.rules"
 
-Why is OMK good for FRESCOR
+** Why is OMK good for FRESCOR
 
      * It is not easy to test FRESCOR simultaneously on multiple platforms.
        With OMK, you can have the same sources compiled for multiple
@@ -145,15 +145,15 @@ Why is OMK good for FRESCOR
        it can be used to compile for OSE. In Pisa, they already use OMK for
        Aquosa.
 
-FAQ
+** FAQ
 
-   How do I debug my Makefile.omk set-up ?
+- How do I debug my Makefile.omk set-up ?
 
    Just activate verbose compilation (V=1 or V=2):
 
   make -f /path/to/Makefile.rules binary-pass V=1
 
-   How do I get back syntax highlighting in Emacs while editing .omk files ?
+- How do I get back syntax highlighting in Emacs while editing .omk files ?
 
    Just add these lines to your $(HOME)/.emacs: