|
1 | | -# Fraunhofer.Fit.IoT.LoraMap (Lora-Map) |
2 | | -Program that displays items with coordinates from Mqtt on a map |
3 | | - |
4 | | -## Linking to |
5 | | -### Internal |
6 | | -* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils)) |
7 | | -* BlubbFish.Utils.IoT ([Utils-IoT](http://git.blubbfish.net/vs_utils/Utils-IoT)) |
8 | | -* BlubbFish.Utils.IoT.Bots ([Bot-Utils](http://git.blubbfish.net/vs_utils/Bot-Utils)) |
9 | | -* BlubbFish.Utils.IoT.Connector.Data.Mqtt ([ConnectorDataMqtt](http://git.blubbfish.net/vs_utils/ConnectorDataMqtt)) |
10 | | - |
11 | | -### External |
12 | | -* litjson |
13 | | -* M2Mqtt |
14 | | -* Mono.Posix |
| 1 | +# Fraunhofer.Fit.IoT.LoraMap (Lora-Map) |
| 2 | +<!-- Short description of the project. --> |
| 3 | + |
| 4 | +Program that displays items with coordinates from Mqtt on a map. This readme is meant for describing the application. |
| 5 | + |
| 6 | + |
| 7 | +<!-- A teaser figure may be added here. It is best to keep the figure small (<500KB) and in the same repo --> |
| 8 | + |
| 9 | +## Getting Started |
| 10 | +<!-- Instruction to make the project up and running. --> |
| 11 | + |
| 12 | +The project documentation is available on the [Wiki](https://github.com/MONICA-Project/lora-map/wiki). |
| 13 | + |
| 14 | +## Deployment |
| 15 | +<!-- Deployment/Installation instructions. If this is software library, change this section to "Usage" and give usage examples --> |
| 16 | + |
| 17 | +This repository is only for containing the code from Lora-Map. If you want to develop, please goto the [Map-Project](https://github.com/MONICA-Project/map-project). This repository contains all references as github submodules, even this one. |
| 18 | + |
| 19 | +## Development |
| 20 | +<!-- Developer instructions. --> |
| 21 | +* Versioning: Use [SemVer](http://semver.org/) and tag the repository with full version string. E.g. `v1.0.0` |
| 22 | + |
| 23 | +### Prerequisite |
| 24 | +This projects depends on different librarys. |
| 25 | + |
| 26 | +#### Linking to |
| 27 | +##### Internal |
| 28 | +* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils)) |
| 29 | +* BlubbFish.Utils.IoT ([Utils-IoT](http://git.blubbfish.net/vs_utils/Utils-IoT)) |
| 30 | +* BlubbFish.Utils.IoT.Bots ([Bot-Utils](http://git.blubbfish.net/vs_utils/Bot-Utils)) |
| 31 | +* BlubbFish.Utils.IoT.Connector.Data.Mqtt ([ConnectorDataMqtt](http://git.blubbfish.net/vs_utils/ConnectorDataMqtt)) |
| 32 | + |
| 33 | +##### External |
| 34 | +* litjson |
| 35 | +* M2Mqtt |
| 36 | +* Mono.Posix |
| 37 | + |
| 38 | +## Contributing |
| 39 | +Contributions are welcome. |
| 40 | + |
| 41 | +Please fork, make your changes, and submit a pull request. For major changes, please open an issue first and discuss it with the other authors. |
| 42 | + |
| 43 | +## Affiliation |
| 44 | + |
| 45 | +This work is supported by the European Commission through the [MONICA H2020 PROJECT](https://www.monica-project.eu) under grant agreement No 732350. |
0 commit comments