README.md 2.28 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 6 7
=====================================
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
8 9 10
-------------------------
- [blc_core](https://framagit.org/blibs/blc_core) : Generic helpers in C or C++ used by all other blaar projects
- [blc_channel](https://framagit.org/blibs/blc_channel) : Tools to use shared memory in synchrone ( in test) and asynchrone mode 
Arnaud Blanchard's avatar
Arnaud Blanchard committed
11
- [blc_image](https://framagit.org/blibs/blc_image) : Manipulate blc_array as images. Can load and save them as png files  
Arnaud Blanchard's avatar
Arnaud Blanchard committed
12
- [blc_program](https://framagit.org/blibs/blc_program) : Parse arguments and interacts with  user in commandline.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
13

Arnaud Blanchard's avatar
Arnaud Blanchard committed
14 15 16 17
Applications for C/C++
----------------------

- [bapps](https://framagit.org/blaar/bapps.git) : Generic tools to manipulate blc_channels (find max, generate oscillators, ...)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
18

Arnaud Blanchard's avatar
Arnaud Blanchard committed
19 20
Install
=======
Arnaud Blanchard's avatar
Arnaud Blanchard committed
21

Arnaud Blanchard's avatar
Arnaud Blanchard committed
22 23
* [Mac OSX](INSTALL_OSX.md)
* [Ubuntu](INSTALL_UBUNTU.md)
Arnaud Blanchard's avatar
Arnaud Blanchard committed
24

Arnaud Blanchard's avatar
Arnaud Blanchard committed
25 26
Adding submodules
-----------------
Arnaud Blanchard's avatar
Arnaud Blanchard committed
27

Arnaud Blanchard's avatar
Arnaud Blanchard committed
28
You will only have basic framework. You may add submodules as needed.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
29

Arnaud Blanchard's avatar
Arnaud Blanchard committed
30
To add  project use : `git submodule add <project repository>`
Arnaud Blanchard's avatar
Arnaud Blanchard committed
31

Arnaud Blanchard's avatar
Arnaud Blanchard committed
32
Once you have added a submodule, install it with `./install.sh <project>|all`
Arnaud Blanchard's avatar
Arnaud Blanchard committed
33

Arnaud Blanchard's avatar
Arnaud Blanchard committed
34
**all** install all your projects (submodules) 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
    bin/<executable> [--help] [others args ...]
Arnaud Blanchard's avatar
Arnaud Blanchard committed
47

Arnaud Blanchard's avatar
Arnaud Blanchard committed
48
All the project has the **--help** which will show a small description of the program and the list of options with theirs descriptions.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
49

Arnaud Blanchard's avatar
Arnaud Blanchard committed
50
It is usefull to add to your `~/.bashrc` on Linux  or to your `~/.bash_profile` on OSX:
51

Arnaud Blanchard's avatar
Arnaud Blanchard committed
52 53 54 55
   export PATH=$PATH:~/blaar/bin
   
Assuming your blaar is in your home ~ .
This allows you to call any blaar executable from anywhere.
Arnaud Blanchard's avatar
Arnaud Blanchard committed
56

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

Arnaud Blanchard's avatar
Arnaud Blanchard committed
59
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
60

Arnaud Blanchard's avatar
Arnaud Blanchard committed
61
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
62