|
| 1 | +# Example Travis CI CMake g++ cpp11 lcov |
| 2 | +[![Travis CI logo][travis-image]][travis-link] |
| 3 | +[![Codecov logo][codecov-image]][codecov-link] |
| 4 | + |
| 5 | +[![Build Status][travis-badge]][travis-link] |
| 6 | +[![codecov][codecov-badge]][codecov-link] |
| 7 | +[![MIT License][license-badge]](LICENSE.md) |
| 8 | + |
| 9 | +Repository that serves as example how to build project with Travis CI, Cmake, lcov and CodeCov. |
| 10 | + |
| 11 | +### Table of Contents |
| 12 | + |
| 13 | +**[Build With](#build)** |
| 14 | +**[Prerequisites](#prereq)** |
| 15 | +**[Authors](#authors)** |
| 16 | +**[License](#license)** |
| 17 | + |
| 18 | +## Built With |
| 19 | + |
| 20 | +The goal of this project is to build project with following tools: |
| 21 | + * C++ version: `C++11` |
| 22 | + * Build system: [`CMake`](https://cmake.org/) |
| 23 | + * C++ compiler: `g++` |
| 24 | + * Libraries: `STL` only |
| 25 | + * Code coverage: [`lcov`](http://ltp.sourceforge.net/coverage/lcov.php) (note: it should show the code coverage is below 100%) |
| 26 | + * [`CodeCov`](https://codecov.io/) (code coverage is measured by CodeCov). |
| 27 | + * Source: multiple files |
| 28 | + |
| 29 | + |
| 30 | +##<a name="prereq"></a> Prerequisites |
| 31 | + |
| 32 | +To build the project you need to install `CMake`. [Here](https://cmake.org/install/) are the instructions. To create code coverage report you need to install `lcov`. [`Download lcov`](http://ltp.sourceforge.net/coverage/lcov.php) from here you can download latest `lcov` and here are [`instructions`](http://ltp.sourceforge.net/coverage/lcov/readme.php). This reports will be later uploaded to CodeCov servers. |
| 33 | + |
| 34 | +##<a name="authors"></a> Authors |
| 35 | + |
| 36 | +* **RokKos** - [RokKos](https://github.com/RokKos) |
| 37 | + |
| 38 | +##<a name="license"></a> License |
| 39 | + |
| 40 | +This project is licensed under the MIT License - see the [LICENSE](https://github.com/RokKos/classes-c-/blob/master/LICENSE) file for details. |
| 41 | + |
| 42 | + |
| 43 | +[travis-badge]: https://travis-ci.org/RokKos/classes-c-.svg?branch=master |
| 44 | +[travis-link]: https://travis-ci.org/RokKos/classes-c- |
| 45 | +[travis-image]: https://github.com/RokKos/classes-c-/blob/master/img/TravisCI.png |
| 46 | +[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg |
| 47 | +[coveralls-badge]: https://coveralls.io/repos/github/RokKos/classes-c-/badge.svg?branch=master |
| 48 | +[coveralls-link]: https://coveralls.io/github/RokKos/classes-c-?branch=master |
| 49 | +[codecov-badge]: https://codecov.io/gh/RokKos/classes-c-/branch/master/graph/badge.svg |
| 50 | +[codecov-link]: https://codecov.io/gh/RokKos/classes-c- |
| 51 | +[codecov-image]: https://github.com/RokKos/classes-c-/blob/master/img/Codecov.png |
0 commit comments