README.md 2.63 KB
Newer Older
Arnaud Blanchard's avatar
Arnaud Blanchard committed
1
[![logo](logo_blaar.png)](http://blaar.org)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
2

Arnaud Blanchard's avatar
Arnaud Blanchard committed
3
Basic Libraries And Applications for Robotics
Arnaud Blanchard's avatar
Arnaud Blanchard committed
4 5
=============================================

Arnaud Blanchard's avatar
Arnaud Blanchard committed
6 7 8
BLAAR is still in active development. It is **not stable yet** and will evolve. Do no hesitate to [ask for improvements or notify issues](https://framagit.org/blaar/blaar/issues).

Basic Libraries for C/C++
Arnaud Blanchard's avatar
Arnaud Blanchard committed
9
-------------------------
Arnaud Blanchard's avatar
Arnaud Blanchard committed
10

Arnaud Blanchard's avatar
Arnaud Blanchard committed
11 12 13 14
- [blc_core](https://promethe.u-cergy.fr/blibs/blc_core) : Generic helpers in C or C++ used by all other blaar projects
- [blc_channel](https://promethe.u-cergy.fr/blibs/blc_channel) : Tools to use shared memory in synchrone ( in test) and asynchrone mode 
- [blc_image](https://promethe.u-cergy.fr/blibs/blc_image) : Manipulate blc_array as images. Can load and save them as png files  
- [blc_program](https://promethe.u-cergy.fr/blibs/blc_program) : Parse arguments and interacts with  user in commandline.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
15

Arnaud Blanchard's avatar
Arnaud Blanchard committed
16 17
Standard blaar applications
---------------------------
Arnaud Blanchard's avatar
Arnaud Blanchard committed
18

Arnaud Blanchard's avatar
Arnaud Blanchard committed
19
- [bapps](https://promethe.u-cergy.fr/blaar/bapps.git) : Generic executables to manipulate blc_channels (find max, generate oscillators, ...)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
20 21

In `scripts/` you have bash scripts which combine applications to produce higher level functionalities. They may require you add optional modules.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
22

Arnaud Blanchard's avatar
Arnaud Blanchard committed
23 24
Install
=======
Arnaud Blanchard's avatar
Arnaud Blanchard committed
25

Arnaud Blanchard's avatar
Arnaud Blanchard committed
26 27
* [Mac OSX](INSTALL_OSX.md)
* [Ubuntu](INSTALL_UBUNTU.md)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
28

Arnaud Blanchard's avatar
Arnaud Blanchard committed
29 30
Adding submodules
-----------------
Arnaud Blanchard's avatar
Arnaud Blanchard committed
31

Arnaud Blanchard's avatar
Arnaud Blanchard committed
32
You will only have basic framework. You may add submodules as needed. To add modules use : `git submodule add <module repository>`. Once you have added a module, install it with **`./install.sh <module>|all`**
Arnaud Blanchard's avatar
Arnaud Blanchard committed
33

Arnaud Blanchard's avatar
Arnaud Blanchard committed
34
**all** install all your cloned modules at once.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
35

Arnaud Blanchard's avatar
Arnaud Blanchard committed
36 37
Update the installation
-----------------------
Arnaud Blanchard's avatar
Arnaud Blanchard committed
38

Arnaud Blanchard's avatar
Arnaud Blanchard committed
39
**`./update_and_install_all.sh`**
Arnaud Blanchard's avatar
Arnaud Blanchard committed
40

Arnaud Blanchard's avatar
Arnaud Blanchard committed
41
This will download the new code and install it for blaar and each submodule
Arnaud Blanchard's avatar
Arnaud Blanchard committed
42 43

Usage 
Arnaud Blanchard's avatar
Arnaud Blanchard committed
44
=====
Arnaud Blanchard's avatar
Arnaud Blanchard committed
45

Arnaud Blanchard's avatar
Arnaud Blanchard committed
46
**`<binary> [--help] [args ...]`**
Arnaud Blanchard's avatar
Arnaud Blanchard committed
47

Arnaud Blanchard's avatar
Arnaud Blanchard committed
48
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.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
49

Arnaud Blanchard's avatar
Arnaud Blanchard committed
50
When your are in development your are advised to see [developement](DEVELOPMENT.md).
Arnaud Blanchard's avatar
Arnaud Blanchard committed
51

Arnaud Blanchard's avatar
Arnaud Blanchard committed
52
You can see an [**example**](https://framagit.org/blibs/blc_core/wikis/home) of manipulating and displaying generic arrays with blc_core
Arnaud Blanchard's avatar
Arnaud Blanchard committed
53

Arnaud Blanchard's avatar
Arnaud Blanchard committed
54
You can create you first project with this example of [image manipulation](https://framagit.org/blibs/blc_image/wikis/home)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
55

Arnaud Blanchard's avatar
Arnaud Blanchard committed
56 57
**SEE ALSO**  [examples](EXAMPLES.md) [development](DEVELOPMENT.md) [git](GIT.md) [Frequently Asked Questions](FAQ.md)