Commit c57ebb4575037fa71a3d06c1996455c55cf8f51e
Committed by
Jan
Jan
1 parent
0f96438e
Add Doxygen link and LGTM to README
Showing
1 changed file
with
6 additions
and
8 deletions
README.md
| 1 | # hueplusplus | 1 | # hueplusplus |
| 2 | A simple and easy to use library for Philips Hue Lights | 2 | A simple and easy to use library for Philips Hue Lights |
| 3 | 3 | ||
| 4 | -| Branch | Travis CI | Codecov | Codacy | | ||
| 5 | -|:-|:-|:-|:-| | ||
| 6 | -| [Master](https://github.com/enwi/hueplusplus/tree/master) | [](https://travis-ci.com/enwi/hueplusplus) | [](https://codecov.io/gh/enwi/hueplusplus) | [](https://www.codacy.com/app/enwi/hueplusplus?utm_source=github.com&utm_medium=referral&utm_content=enwi/hueplusplus&utm_campaign=Badge_Grade) | | ||
| 7 | -| [Development](https://github.com/enwi/hueplusplus/tree/development) | [](https://travis-ci.com/enwi/hueplusplus) | [](https://codecov.io/gh/enwi/hueplusplus) | [](https://www.codacy.com/app/enwi/hueplusplus?utm_source=github.com&utm_medium=referral&utm_content=enwi/hueplusplus&utm_campaign=Badge_Grade) | | 4 | +| Branch | Travis CI | Codecov | Codacy | LGTM |
| 5 | +|:-|:-|:-|:-|:-| | ||
| 6 | +| [Master](https://github.com/enwi/hueplusplus/tree/master) | [](https://travis-ci.com/enwi/hueplusplus) | [](https://codecov.io/gh/enwi/hueplusplus) | [](https://www.codacy.com/app/enwi/hueplusplus?utm_source=github.com&utm_medium=referral&utm_content=enwi/hueplusplus&utm_campaign=Badge_Grade) | [](https://lgtm.com/projects/g/enwi/hueplusplus/context:cpp) | | ||
| 7 | +| [Development](https://github.com/enwi/hueplusplus/tree/development) | [](https://travis-ci.com/enwi/hueplusplus) | [](https://codecov.io/gh/enwi/hueplusplus) | [](https://www.codacy.com/app/enwi/hueplusplus?utm_source=github.com&utm_medium=referral&utm_content=enwi/hueplusplus&utm_campaign=Badge_Grade) | | | ||
| 8 | 8 | ||
| 9 | ## Features | 9 | ## Features |
| 10 | * find bridges with SSDP or set an ip manually | 10 | * find bridges with SSDP or set an ip manually |
| 11 | * function to assign a username or set one manually | 11 | * function to assign a username or set one manually |
| 12 | * all common light functions (brightness, color, temperature) | 12 | * all common light functions (brightness, color, temperature) |
| 13 | * extended alert() functions, which alert in a specific color (good for notifications) | 13 | * extended alert() functions, which alert in a specific color (good for notifications) |
| 14 | -* documented with doxygen | 14 | +* [documented with doxygen](https://enwi.github.io/hueplusplus/) |
| 15 | * tested with google test, google mock and gcov/lcov | 15 | * tested with google test, google mock and gcov/lcov |
| 16 | 16 | ||
| 17 | ## Compatibility | 17 | ## Compatibility |
| @@ -95,9 +95,7 @@ light1.hasColorControl(); | @@ -95,9 +95,7 @@ light1.hasColorControl(); | ||
| 95 | These will either return true(light has specified function) or false(light lacks specified function). | 95 | These will either return true(light has specified function) or false(light lacks specified function). |
| 96 | 96 | ||
| 97 | ### Further reading | 97 | ### Further reading |
| 98 | -If you want to know more about all functions just look inside the doxygen description, | ||
| 99 | -which for now can be found in the regarding sourcecode file or create the documentation | ||
| 100 | -with the provided Doxyfile yourself. | 98 | +If you want to know more about all functions just look inside the doxygen documentation. It can be found [here](https://enwi.github.io/hueplusplus/) |
| 101 | 99 | ||
| 102 | ## Build and install | 100 | ## Build and install |
| 103 | ### Basic installation | 101 | ### Basic installation |