Commit 10d0a79d authored by Arnaud Blanchard's avatar Arnaud Blanchard

Update README.md

parent d1ca8ff1
......@@ -17,11 +17,9 @@ Install
* [Mac OSX](INSTALL_OSX.md)
* [Ubuntu/Raspbian](INSTALL_UBUNTU.md)
Structure
=========
blibs - Basic Libraries
-----------------------
=======================
These libraries are a set of basic tools simplifying programmation. The programmer keeps full control on the program. You have shortcuts for classical functionalities and very little abstractions. You can freely mix blibs and low level C/C++ functions.
- [blc_core](https://promethe.u-cergy.fr/blibs/blc_core) : Generic helpers in C or C++ used by all other blaar projects
......@@ -30,7 +28,7 @@ These libraries are a set of basic tools simplifying programmation. The programm
- [blc_program](https://promethe.u-cergy.fr/blibs/blc_program) : Parse arguments and interacts with user in commandline.
Modules
-------
=======
- [bapps](https://promethe.u-cergy.fr/blaar/bapps.git): Basic Applications for C/C++ with no dependency to manipulate blc_channels (find max, generate oscillators, ...)
......@@ -38,18 +36,23 @@ All the other modules are optional have dependencies
- [gnuplot](https://promethe.u-cergy.fr/blaar/gnuplot.git) Allows to make graphs from data of blc_channels (require gnuplot)
### specific Linux
Specific Linux
--------------
- [a_sound](https://promethe.u-cergy.fr/blaar/asound.git) Acquire or produce sound using Advanced Linux Sound Architecture library (require libasounddev).
- [i_v4l2_camera](https://promethe.u-cergy.fr/blaar/iv4l2camera.git) Acquire images from a camera using Video 4 Linux library (require libv4l2dev).
### specific Mac OSX
Specific Mac OSX
----------------
- [coreaudio](https://promethe.u-cergy.fr/blaar/asound.git) Acquire or produce sound using Apple Core Audio Frameworks
- [i_AV_camera](https://promethe.u-cergy.fr/blaar/i_AV_camera.git) Acquire images from cameras using Audio Video Foundation
In `scripts/` you have bash scripts which combine applications to produce higher level functionalities. They may require you add optional modules.
Usage
=====
Adding submodules
-----------------
......@@ -64,8 +67,8 @@ Update the installation
This will download the new code and install it for blaar and each submodule
Usage
=====
Execution of programs
---------------------
**`<binary> [--help] [args ...]`**
The availble blaar binaries are in `bin/` directory. All the binaries accept the **`--help`** option which shows a description of the project and details of possible others options. You can also use scripts which run a combinaison of binaries and other scripts. They are in `scripts/` directory and accept the **`-h`** option which shows a description of the project and details of possible others options.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment