esri_assignment/README.md

50 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-06-17 20:14:50 +02:00
# ESRI C++ code assignment
2021-06-28 00:12:07 +02:00
## Requirements
The requirements specification is provided in `assignment.pdf`.
## Design remarks
For sake of simplicity most of validation and error handling is performed during
loading the input files.
2021-06-17 20:14:50 +02:00
## Setup
2021-06-28 00:12:07 +02:00
Execute the bash script `install_deps.sh` on a Debian GNU/Linux system to install
the required dependencies.
The protobuf dependencies are installed as Debian packages. All other dependencies
are installed using the CMake FetchContent feature.
2021-06-17 20:14:50 +02:00
## Build
2021-06-28 00:12:07 +02:00
Execute the bash script `build.sh` to perform both build and testing steps.
The overall process is implemented using CMake. The application artifact is located
at `build/src/main`.
## Usage
The command-line parameters can be passed as follows:
2021-06-17 20:14:50 +02:00
```
2021-06-28 00:12:07 +02:00
main <input-file[s]> <json-ouput-file>
2021-06-17 20:14:50 +02:00
```
2021-06-28 00:12:07 +02:00
* At least one *input-file* and *json-ouptut-file* must be provided.
* Multiple *input-files* are supported.
2021-06-17 20:14:50 +02:00
2021-06-28 00:12:07 +02:00
## Links
* Protobuf
* https://developers.google.com/protocol-buffers/docs/cpptutorial
* https://github.com/protocolbuffers/protobuf/tree/master/examples
* https://cmake.org/cmake/help/latest/module/FindProtobuf.html
* Json C++ library
* https://github.com/nlohmann/json
* Catch2 unit testing framework
* https://github.com/catchorg/Catch2