Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
av/ | H | 03-May-2022 | - | 2,157 | 1,321 | |
events/ | H | 03-May-2022 | - | 1,673 | 932 | |
examples/ | H | 03-May-2022 | - | 70 | 36 | |
graphics/ | H | 03-May-2022 | - | 23,305 | 15,142 | |
include/ignition/common/ | H | 03-May-2022 | - | 4,982 | 1,933 | |
src/ | H | 03-May-2022 | - | 9,841 | 6,413 | |
test/ | H | 03-May-2022 | - | 36,897 | 24,342 | |
tools/ | H | 03-May-2022 | - | 6,449 | 4,138 | |
tutorials/ | H | 03-May-2022 | - | 4 | 2 | |
AUTHORS | H A D | 05-Nov-2018 | 14 | 2 | 1 | |
COPYING | H A D | 05-Nov-2018 | 9.9 KiB | 179 | 150 | |
Changelog.md | H A D | 05-Nov-2018 | 2.3 KiB | 56 | 36 | |
LICENSE | H A D | 05-Nov-2018 | 617 | 16 | 11 | |
Migration.md | H A D | 05-Nov-2018 | 1.1 KiB | 32 | 23 | |
NEWS | H A D | 05-Nov-2018 | 29 | 2 | 1 | |
README.md | H A D | 05-Nov-2018 | 1.6 KiB | 90 | 53 | |
api.md.in | H A D | 05-Nov-2018 | 474 | 11 | 6 | |
bitbucket-pipelines.yml | H A D | 05-Nov-2018 | 1.9 KiB | 60 | 57 | |
codecov.yml | H A D | 05-Nov-2018 | 27 | 3 | 2 | |
configure.bat | H A D | 05-Nov-2018 | 1,010 | 26 | 18 | |
cppcheck.suppress.in | H A D | 05-Nov-2018 | 51 | 4 | 3 | |
tutorials.md.in | H A D | 05-Nov-2018 | 543 | 12 | 7 |
README.md
1# Ignition Common 2 3** Ignition Common classes and functions for robot applications.** 4 5Ignition Common is a component in the ignition framework, a set 6of libraries designed to rapidly develop robot applications. 7 8[http://ignitionrobotics.org](http://ignitionrobotics.org) 9 10Test coverage: 11 12[![codecov](https://codecov.io/bb/ignitionrobotics/ign-common/branch/master/graph/badge.svg)](https://codecov.io/bb/ignitionrobotics/ign-common) 13 14## Installation 15 16Standard installation can be performed in UNIX systems using the following 17steps: 18 19 mkdir build/ 20 cd build/ 21 cmake .. 22 sudo make install 23 24## Uninstallation 25 26To uninstall the software installed with the previous steps: 27 28 cd build/ 29 sudo make uninstall 30 31## Test 32 33Run tests as follows: 34 35 make test 36 37> Tests are automatically built. To disable them, run `cmake` as follows: 38 39 cmake .. -DENABLE_TESTS_COMPILATION=false 40 41### Test coverage 42 43To run test coverage: 44 451. Install LCOV 46 47 sudo apt-get install lcov 48 491. Build with coverage 50 51 cd build/ 52 cmake .. -DCMAKE_BUILD_TYPE=coverage 53 make 54 551. Run tests 56 57 make test 58 591. Generate coverage 60 61 make coverage 62 631. View results 64 65 firefox coverage/index.html 66 67## Create Documentation & Release 68 691. Build documentation 70 71``` 72cd build 73make doc 74``` 75 761. Upload documentation to ignitionrobotics.org. 77 78``` 79cd build 80sh upload.sh 81``` 82 831. If you're creating a new release, then tell ignitionrobotics.org about 84 the new version. For example: 85 86``` 87curl -k -X POST -d '{"libName":"common", "version":"1.0.0", "releaseDate":"2017-10-09T12:10:13+02:00","password":"secret"}' https://api.ignitionrobotics.org/1.0/versions 88``` 89 90