diff --git a/Lora-Map.jpg b/Lora-Map.jpg new file mode 100644 index 0000000..c8fe2d2 Binary files /dev/null and b/Lora-Map.jpg differ diff --git a/Lora-Map/Lora-Map.csproj b/Lora-Map/Lora-Map.csproj index 216558a..1b15748 100644 --- a/Lora-Map/Lora-Map.csproj +++ b/Lora-Map/Lora-Map.csproj @@ -64,6 +64,7 @@ + PreserveNewest diff --git a/README.md b/README.md index aab53b9..b3a88df 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,45 @@ -# Fraunhofer.Fit.IoT.LoraMap (Lora-Map) -Program that displays items with coordinates from Mqtt on a map - -## Linking to -### Internal -* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils)) -* BlubbFish.Utils.IoT ([Utils-IoT](http://git.blubbfish.net/vs_utils/Utils-IoT)) -* BlubbFish.Utils.IoT.Bots ([Bot-Utils](http://git.blubbfish.net/vs_utils/Bot-Utils)) -* BlubbFish.Utils.IoT.Connector.Data.Mqtt ([ConnectorDataMqtt](http://git.blubbfish.net/vs_utils/ConnectorDataMqtt)) - -### External -* litjson -* M2Mqtt -* Mono.Posix \ No newline at end of file +# Fraunhofer.Fit.IoT.LoraMap (Lora-Map) + + +Program that displays items with coordinates from Mqtt on a map. This readme is meant for describing the application. + +![Picture of the Application](Lora-Map.jpg) + + +## Getting Started + + +The project documentation is available on the [Wiki](https://github.com/MONICA-Project/lora-map/wiki). + +## Deployment + + +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. + +## Development + +* Versioning: Use [SemVer](http://semver.org/) and tag the repository with full version string. E.g. `v1.0.0` + +### Prerequisite +This projects depends on different librarys. + +#### Linking to +##### Internal +* BlubbFish.Utils ([Utils](http://git.blubbfish.net/vs_utils/Utils)) +* BlubbFish.Utils.IoT ([Utils-IoT](http://git.blubbfish.net/vs_utils/Utils-IoT)) +* BlubbFish.Utils.IoT.Bots ([Bot-Utils](http://git.blubbfish.net/vs_utils/Bot-Utils)) +* BlubbFish.Utils.IoT.Connector.Data.Mqtt ([ConnectorDataMqtt](http://git.blubbfish.net/vs_utils/ConnectorDataMqtt)) + +##### External +* litjson +* M2Mqtt +* Mono.Posix + +## Contributing +Contributions are welcome. + +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. + +## Affiliation +![MONICA](https://github.com/MONICA-Project/template/raw/master/monica.png) +This work is supported by the European Commission through the [MONICA H2020 PROJECT](https://www.monica-project.eu) under grant agreement No 732350. \ No newline at end of file