From c515d757de9bd6c5a3a940654822e3f290526183 Mon Sep 17 00:00:00 2001 From: Romain Bazile Date: Mon, 28 Sep 2020 14:53:59 +0200 Subject: [PATCH] First README rewrite --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7387c72..946fc3d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ -# PlanktoScop Main Repository -The PlanktoScop is an open and affordable modular imaging platform for citizen oceanography. +# An open and affordable imaging platform for citizen oceanography -This GitHub is part of a community that you can find on [its website](https://www.planktonscope.org/). +![PlanktoScope Render](docs/readme/planktoscope_cad.png) -# Fast Setup +![Plankton collage](docs/readme/plankton_collage.jpg) -Before going further, notice that you can download the image disk already setup without having to deal with all these command lines. -Jump here : http://planktonscope.su.domains/Images_raspberry/Raspbian_Buster_Morphocut_WiFi.img -# Expert Setup -After getting your kit and finding the necessary components, but before assembling your kit, you should take the time to do a mockup build and setup your Raspberry. +# What is this? +The PlanktoScope is an open-source, affordable imaging platform for citizen oceanography. It's built around a Raspberry Pi, a couple of HATs, some stepper motors and a few centimeters of silicon tubes. Its cost is at about $500 in parts. + +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 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)| +|--------|--------| + + +# Key Features +- A list +- of a lot of +- features! + +# How do I build one? +You can access the complete documentation on [Read The Docs](https://planktonscope.readthedocs.io/).