curious.bio/planktoscope
curious.bio/planktoscope
9
0
Fork 0
Code Issues 10 Pull requests Packages Projects 7 Releases Wiki Activity

Various small updates

Browse source
This commit is contained in:
Romain Bazile 2020-09-28 21:35:19 +02:00
parent 2f55f396d8
commit 24eee73e2b
3 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -10,6 +10,8 @@ The PlanktoScope is an open-source, affordable imaging platform for citizen ocea
The goal of the PlanktoScope is to allow citizen to engage in scientific programs, either at sea or onshore. You can use the PlanktoScope to image the different species of Plankton living in a body of water. The goal of the PlanktoScope is to allow citizen to engage in scientific programs, either at sea or onshore. You can use the PlanktoScope to image the different species of Plankton living in a body of water.
## Get the papers!
The PlanktoScope has been described in a paper available on the [bioRxiv preprint server](https://www.biorxiv.org/content/10.1101/2020.04.23.056978v1). The first results of this program and its outline are also available as a [preprint](https://www.biorxiv.org/content/10.1101/2020.08.31.263442v1). The PlanktoScope has been described in a paper available on the [bioRxiv preprint server](https://www.biorxiv.org/content/10.1101/2020.04.23.056978v1). The first results of this program and its outline are also available as a [preprint](https://www.biorxiv.org/content/10.1101/2020.08.31.263442v1).
|[![PlanktoScope Preprint](docs/readme/planktoscope_pub.png)](https://www.biorxiv.org/content/10.1101/2020.04.23.056978v1)|[![PlanktonPlanet Preprint](docs/readme/planktonplanet_pub.png)](https://www.biorxiv.org/content/10.1101/2020.08.31.263442v1)| |[![PlanktoScope Preprint](docs/readme/planktoscope_pub.png)](https://www.biorxiv.org/content/10.1101/2020.04.23.056978v1)|[![PlanktonPlanet Preprint](docs/readme/planktonplanet_pub.png)](https://www.biorxiv.org/content/10.1101/2020.08.31.263442v1)|

10
docs/README.md
View file

@ -8,14 +8,18 @@ You can find here more information about how to build your own PlanktoScope.
- [How to setup your PlanktoScope the easy way](easy_install) - [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) - [How to setup your PlanktoScope the hard way (also known as the Expert's path)](expert_setup)
- [Some information about how to setup a remote access](remote_access)
## Usage ## Usage
- [Information about collection devices](collection_devices) - [Information about collection devices](collection_devices)
## Under the hood:
- [Software architecte](software_architecture)
- [MQTT Messages](mqtt_messages)
## Contribute ## Contribute
- [Find out how to contribute to this documentation and help edit it](edit_this_doc) - [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) - [Contribute to the code, here is the getting started](edit_the_code)
## Under the hood: ## License of our work
- [Software architecte](software_architecture) - [More information about the licenses that we use](license)
- [MQTT Messages](mqtt_messages)

14
docs/edit_this_doc.md
View file

@ -1,4 +1,4 @@
# Edit this documentation # Edit this documentation!
This documentation is hosted by [ReadTheDocs.org](https://readthedocs.org/) at https://planktonscope.readthedocs.io/. This documentation is hosted by [ReadTheDocs.org](https://readthedocs.org/) at https://planktonscope.readthedocs.io/.
@ -11,3 +11,15 @@ The local development and test is made using [mkdocs](https://www.mkdocs.org/).
If you want to include pictures and diagrams in the documentation, please set the pictures in a dedicated folder to the name of the page you are creating (for example, if your page is named `expert_setup.md`, please put all the related pictures in the `docs/expert_setup/` folder). Each picture should be named with a simple yet descriptive name, using jpg or png format if possible. Try to limit the size of the file by limiting the resolution to what is necessary for the picture to be clear on screen. If you want to include pictures and diagrams in the documentation, please set the pictures in a dedicated folder to the name of the page you are creating (for example, if your page is named `expert_setup.md`, please put all the related pictures in the `docs/expert_setup/` folder). Each picture should be named with a simple yet descriptive name, using jpg or png format if possible. Try to limit the size of the file by limiting the resolution to what is necessary for the picture to be clear on screen.
Contributions should be made by creating pull requests on [Github directly](https://github.com/PlanktonPlanet/PlanktonScope/pulls). Contributions should be made by creating pull requests on [Github directly](https://github.com/PlanktonPlanet/PlanktonScope/pulls).
## Extensions available
In addition to the common markdown syntax, several extensions are activated. If you want more information on any of them, please follow the linked guides.
- [SmartyPants](https://python-markdown.github.io/extensions/smarty/): Converts ASCII dashes, quotes and ellipses to their HTML entity equivalents.
- [Sane Lists](https://python-markdown.github.io/extensions/sane_lists/): Alters the behavior of the Markdown List syntax to be less surprising.
- [Admonition](https://python-markdown.github.io/extensions/admonition/): Adds rST-style admonitions to Markdown documents.
- [Table of contents](https://python-markdown.github.io/extensions/toc/): Generates a Table of Contents from a Markdown document and adds it into the resulting HTML document.
- [Metadata](https://python-markdown.github.io/extensions/meta_data/): Adds a syntax for defining meta-data about a document.
- [Tables](https://python-markdown.github.io/extensions/tables/): Adds the ability to create tables in Markdown documents.
- [Fenced Code Blocks](https://python-markdown.github.io/extensions/fenced_code_blocks/): Adds a secondary way to define code blocks.