Skip to content

Commit 81a0adf

Browse files
committed
Initial commit
0 parents  commit 81a0adf

File tree

5 files changed

+106
-0
lines changed

5 files changed

+106
-0
lines changed

.gitignore

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Compiled Object files
2+
*.slo
3+
*.lo
4+
*.o
5+
*.obj
6+
7+
# Precompiled Headers
8+
*.gch
9+
*.pch
10+
11+
# Compiled Dynamic libraries
12+
*.so
13+
*.dylib
14+
*.dll
15+
16+
# Fortran module files
17+
*.mod
18+
*.smod
19+
20+
# Compiled Static libraries
21+
*.lai
22+
*.la
23+
*.a
24+
*.lib
25+
26+
# Executables
27+
*.exe
28+
*.out
29+
*.app
30+
31+
# Ignored folders
32+
bin/
33+
build/
34+
lib/

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Rok Kos
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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

img/Codecov.png

1.24 KB
Loading

img/TravisCI.png

5.29 KB
Loading

0 commit comments

Comments
 (0)