Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
.github/ | H | 14-Nov-2021 | - | 41 | 31 | |
cmake/ | H | 14-Nov-2021 | - | 32 | 26 | |
example/ | H | 03-May-2022 | - | 81 | 55 | |
include/kImageAnnotator/ | H | 14-Nov-2021 | - | 123 | 68 | |
resources/ | H | 14-Nov-2021 | - | 109 | 106 | |
src/ | H | 03-May-2022 | - | 24,325 | 14,322 | |
tests/ | H | 03-May-2022 | - | 9,059 | 5,482 | |
translations/ | H | 03-May-2022 | - | 12,041 | 12,015 | |
.gitignore | H A D | 14-Nov-2021 | 660 | 73 | 63 | |
CHANGELOG.md | H A D | 14-Nov-2021 | 16 KiB | 168 | 152 | |
LICENSE | H A D | 14-Nov-2021 | 7.5 KiB | 166 | 128 | |
README.md | H A D | 14-Nov-2021 | 2.4 KiB | 58 | 40 |
README.md
1# kImageAnnotator [![Build Status][github-badge]][github-url] [![Translation status][weblate-badge]][weblate-url] 2Tool for annotating images 3 4Version 0.5.3 5 6![kImageAnnotator](https://i.imgur.com/4vlPDUn.png "kImageAnnotator") 7 8### Dependencies 9 10kImageAnnotator depends on [kColorPicker](https://github.com/ksnip/kColorPicker) which needs 11to be installed before building kImageAnnotator. Install instructions can be found on the github page. 12 13### Building from source 14 151. Get latest release from GitHub by cloning the repo: 16 `$ git clone https://github.com/ksnip/kImageAnnotator` 172. Change to repo directory: 18 `$ cd kImageAnnotator` 193. Make new build directory and enter it: 20 `$ mkdir build && cd build` 214. Create the makefile and build the project: 22 `$ cmake .. && make` 235. Install shared library (not required when only using the example): 24 `$ sudo make install` 256. Run the example application: 26 `$ ./example/kImageAnnotator-example` 27 28### Shared vs Static 29 30You can either build the project as shared library by providing the flag `-DBUILD_SHARED_LIBS=ON` 31to cmake or `-DBUILD_SHARED_LIBS=OFF` to build as static library. When no flag is provided a 32static library is build. For windows we currently only support building as static library. 33 34### Integrate library 35 361. Let cmake find the shared library, optionally with version 37 `set(KIMAGEANNOTATOR_MIN_VERSION "0.x.x")` 38 `find_package(kImageAnnotator ${KIMAGEANNOTATOR_MIN_VERSION} REQUIRED)` 39 402. Link the library with your application 41 `target_link_libraries(myApp kImageAnnotator)` 42 43 44### Translations 45We are always looking for help with translations, contributors are welcome! 46For translations we use [Weblate](https://hosted.weblate.org/projects/kimageannotator/kimageannotator/)! 47[![Translation status](https://hosted.weblate.org/widgets/kimageannotator/-/kimageannotator/multi-green.svg)](https://hosted.weblate.org/engage/kimageannotator/?utm_source=widget) 48 49 50### Acknowledgement 51Stickers designed by [OpenMoji](https://openmoji.org/) – the open-source emoji and icon project. 52 53 54[github-badge]: https://github.com/ksnip/kImageAnnotator/actions/workflows/build.yml/badge.svg 55[github-url]: https://github.com/ksnip/kImageAnnotator/actions 56 57[weblate-badge]: https://hosted.weblate.org/widgets/kimageannotator/-/kimageannotator/svg-badge.svg 58[weblate-url]: https://hosted.weblate.org/engage/kimageannotator/?utm_source=widget