planktoscope/docs/README.md

26 lines
902 B
Markdown
Raw Normal View History

2020-09-28 13:33:52 +02:00
# Welcome to the PlanktoScope build and use documentation
![PlanktoScope](readme/planktoscope_cad.webp)
2020-09-28 13:33:52 +02:00
You can find here more information about how to build your own PlanktoScope.
## Setup
- [How to setup your PlanktoScope the easy way](easy_install)
- [How to setup your PlanktoScope the hard way (also known as the Expert's path)](expert_setup)
2020-09-28 21:35:19 +02:00
- [Some information about how to setup a remote access](remote_access)
2020-09-28 13:33:52 +02:00
## Usage
- [Information about collection devices](collection_devices)
2020-09-28 21:35:19 +02:00
## Under the hood:
- [Software architecture](software_architecture)
2020-09-28 21:35:19 +02:00
- [MQTT Messages](mqtt_messages)
- How does the segmentation works (soon)
2020-09-28 21:35:19 +02:00
2020-09-28 13:33:52 +02:00
## Contribute
- [Find out how to contribute to this documentation and help edit it](edit_this_doc)
- [Contribute to the code, here is the getting started](edit_the_code)
2020-09-28 21:35:19 +02:00
## License of our work
- [More information about the licenses that we use](license)