diff --git a/README.md b/README.md new file mode 100644 index 0000000..82869e9 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Nutrient_app + +## Table of Contents +* [Introduction](#introduction) +* [Branches](#branches) +* [Compiling](#compiling) +* [Execution](#execution) +* [Visualization](#visualization) +* [Working Example](#working-example) + +## Introduction +### Background +The Nutrient App project aims at supporting the reduction of nutrient export to rivers and lakes by engaging citizens, farmers and water quality managers in the real-time monitoring of dissolved nutrient concentrations (N, P) in aquatic freshwater systems. The mobile application allows obtaining on-farm instantaneous community-based nutrient measurements based on cheap standard commercially available test kits. The mobile app can be used to monitor the quality of wells, streams, wetlands and lakes. It will enable to identify possible sources and hotspots of contamination, which will empower the participants to take remedial action. The measurements are georeferenced and can be uploaded to a server managed by the GWF’s data management team. The results will be displayed in a map that can be visualized directly through the app or from a web browser for further analysis. + +### Reading material +* Coming soon! + +## Branches +### Active +* main: primary branch with latest verified updates to the working code +* development: used to verify updates from feature branches before merging with main +* Retrieve_serverdata: feature branch + +### Notes +* Note that the primary branch (formerly known as "master") was renamed as "main" +* If using a local clone with the previous naming scheme, the clone may be updated using the following Git commands: +``` +$ git branch -m master main +$ git fetch -p origin +$ git branch -u origin/main main +``` + +## Compiling +* CMake: [CMakeLists.txt](CMakeLists.txt) is provided +* CMake minimum version: 3.10 + +## Execution +* Coming soon! + +## Visualization +* Coming soon! + +## Working Example +* Coming soon!