Inter-executor invocation bugs fixed.

[frescor/frsh-forb.git] / README

diff --git a/README b/README
index 5ee3ff64bc417dc2653f2d2ce3e84bd50445b6b7..e2a0ee82d9ee8a1a0b1803d133f5d656d5780a56 100644 (file)
--- a/README
+++ b/README
@@ -18,10 +18,14 @@
 
 * BUILDING FRSH/FORB FRAMEWORK
 
-1) Initialize and download additional submodules:
-   
-   git submodule init
-   git submodule update
+1) Install prerequisites. On Debian/Ubuntu:
+
+     apt-get install libidl-dev libcpufreq-dev libacpi-dev \
+                    libcgroup-dev libncurses5-dev
+
+   To build camera demo, you need to:
+
+     apt-get install freeglut3-dev
 
 2) Go to build directory and configure the build:
    
@@ -35,57 +39,51 @@
    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.
+   (echo CONFIG_AQUOSA=n >> config.omk) or can use cgroups (echo
+   CONFIG_CPUCG=y >> config.omk). Note, that cgroups support is not
+   well tested, but we plan to work on it.
 
 3) Compile it:
 
    make
 
+4) Test it:
 
+   ./_compiled/bin/fcb &
+   ./_compiled/bin/frm_dummy &
+   ./_compiled/bin/frm_gui &
+   ./_compiled/bin-tests/dummy_renegotiation
 
-* OLD HOWTO - may be out of date
+* DIRECTORY STRUCTURE
+
+  * build/* - configuration for different build targets
+
+  * build/aquosa - default build for linux
+
+  * build/marte - build for MarteOS. Not completely supported now.
+
+  * src - all sources
 
-    Linux + AQuoSA
-
-     * Install AQuoSA (http://aquosa.sourceforge.net)
-     * $HOME/frescor/src/omk-build/aquosa
-     * Adjust symlinks to FRESCOR modules (fosa, frsh, utils, ...) or use ./create-links script
-     * Create config.omk containing (or use a shell variable in your .bashrc)
-
-  AQUOSA_ROOT=/path/to/aquosa/install/path
-
-     * Actually, my preferred way of working is adding the following
-       variables in .bashrc:
-
-  # AQuoSA environment
- 
-  export AQUOSA_ROOT=/usr/local/aquosa
-  export PATH="$PATH:$AQUOSA_ROOT/bin"
-  export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$AQUOSA_ROOT/lib"
- 
-  # FRESCOR environment
- 
-  export PLATFORM=AQuoSA
-  export FOSA_ROOT=$HOME/path/to/fosa
-  export FRSH_ROOT=$HOME/path/to/frsh
-  export UTILS_ROOT=$HOME/path/to/utils
-  LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$FOSA_ROOT/lib:$FRSH_ROOT/lib:$UTILS_ROOT/lib"
- 
-  # OMK environment
- 
-  # Use `omk' for OMK-enabled sources
-  alias omk="make -f $HOME/path/to/Makefile.rules"
-  # link headers instead of copying them
-  export LN_HEADERS=y
-
-     * Create default-configuration by running
-
-  make default-config
-
-     * Run
-
-  make
+  * src/forb - CORBA-like middle for interprocess and inter-node
+    communication.
+
+  * src/frsh - The core of resource reservation framework.
+
+  * src/frsh-include - FRSH API headers from FRESCOR project. Our FRSH
+    framework implements this API.
+
+  * src/fosa - Operating system adaptation layer
+
+  * src/ulut - library providing generic data types and algorithms
+    (AVL trees etc.).
+
+  * src/fna - Network adaptation layer = unified API for plugging in
+    different network protocols.
+
+  * src/fwp - Communication protocol and resource management for WiFi
+    (also works with Ethernet).
+
+* OLD HOWTO - may be out of date
 
 ** Further remarks