diff --git a/README.md b/README.md index af2678e..03d6ab3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ + + # An open and affordable imaging platform for citizen oceanography ![PlanktoScope Render](docs/readme/planktoscope_cad.webp) diff --git a/docs/README.md b/docs/README.md index 2edf552..503b2dc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,7 @@ + + # Welcome to the PlanktoScope build and use documentation ![PlanktoScope](readme/planktoscope_cad.webp) diff --git a/docs/assembly_guide.md b/docs/assembly_guide.md index 0de7dc8..f0a65f2 100644 --- a/docs/assembly_guide.md +++ b/docs/assembly_guide.md @@ -1,3 +1,7 @@ + + # Assembly guide of the PlanktoScope ![Complete](assembly_guide/pictures/complete.webp) diff --git a/docs/changelog.md b/docs/changelog.md index 6821bf0..1ce5c1d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,7 @@ + + # Changelog ## Image changelog diff --git a/docs/collection_devices.md b/docs/collection_devices.md index 2cc6484..bb17e4c 100644 --- a/docs/collection_devices.md +++ b/docs/collection_devices.md @@ -1,3 +1,7 @@ + + # Plankton Net The simplest device you can use is a plankton net. It should be made of a fine mesh, down to 20 micron. It can be towed behind a boat at low speed (less than 2 knots) or towed by hand in a river or a lake. diff --git a/docs/create_sd.md b/docs/create_sd.md index 0a127b8..f3d0e45 100644 --- a/docs/create_sd.md +++ b/docs/create_sd.md @@ -1,3 +1,7 @@ + + # How to create a new SD master card, or backup efficiently your existing card If you want to backup your machine, or prepare an image from the golden machine to share it to the world (or your students), you may want to follow those steps. diff --git a/docs/easy_install.md b/docs/easy_install.md index 09f4cbc..21c2900 100644 --- a/docs/easy_install.md +++ b/docs/easy_install.md @@ -1,3 +1,7 @@ + + # PlanktoScope Simple Setup Guide ## Download the image diff --git a/docs/edit_the_code.md b/docs/edit_the_code.md index 04b5ad3..f43aa98 100644 --- a/docs/edit_the_code.md +++ b/docs/edit_the_code.md @@ -1,3 +1,7 @@ + + # How to help development for the PlanktoScope code We are using the [Github Flow approach](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests) for our development efforts. diff --git a/docs/edit_this_doc.md b/docs/edit_this_doc.md index c08ff01..c3ea4e2 100644 --- a/docs/edit_this_doc.md +++ b/docs/edit_this_doc.md @@ -1,3 +1,7 @@ + + # Edit this documentation This documentation is hosted by [ReadTheDocs.org](https://readthedocs.org/) at . diff --git a/docs/expert_setup.md b/docs/expert_setup.md index c87e6e1..3091a93 100644 --- a/docs/expert_setup.md +++ b/docs/expert_setup.md @@ -1,3 +1,7 @@ + + # Expert Setup ## Install and setup Raspbian on your Raspberry Pi diff --git a/docs/getting_started.md b/docs/getting_started.md index 303cc25..8c0a423 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,3 +1,7 @@ + + # Getting started with using the machine Congratulations! You have finished assembling your machine, now is the time to test it and learn how to use it! diff --git a/docs/hat_hardware.md b/docs/hat_hardware.md index 812b752..ca56335 100644 --- a/docs/hat_hardware.md +++ b/docs/hat_hardware.md @@ -1,3 +1,7 @@ + + # PlanktoScope Hat Hardware ## Buses and GPIO pinout diff --git a/docs/license.md b/docs/license.md index 2305f4c..8cb36ba 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,3 +1,7 @@ + + # Our work is fully open source That's the headline, yes. diff --git a/docs/mqtt_messages.md b/docs/mqtt_messages.md index 6a75206..01e8dc4 100644 --- a/docs/mqtt_messages.md +++ b/docs/mqtt_messages.md @@ -1,3 +1,7 @@ + + # Details about used MQTT messages ## Topic lists diff --git a/docs/remote_access.md b/docs/remote_access.md index 7437231..58c1c80 100644 --- a/docs/remote_access.md +++ b/docs/remote_access.md @@ -1,3 +1,7 @@ + + # Remote access via a standalone network This tutorial is adapted from a tutorial that you can find [here](https://www.raspberryconnect.com/projects/65-raspberrypi-hotspot-accesspoints/157-raspberry-pi-auto-wifi-hotspot-switch-internet). diff --git a/docs/software_architecture.md b/docs/software_architecture.md index 574bdac..2c0a86a 100644 --- a/docs/software_architecture.md +++ b/docs/software_architecture.md @@ -1,3 +1,7 @@ + + # Our software architecture ## Node-Red diff --git a/docs/ui_guide.md b/docs/ui_guide.md index 65041f7..a4671b0 100644 --- a/docs/ui_guide.md +++ b/docs/ui_guide.md @@ -1,3 +1,7 @@ + + # User interface guide Starting with the release of v2.2, a new user interface brings a whole new user interface. This guide will help you get familiar with it. diff --git a/docs/update_device-tree.md b/docs/update_device-tree.md index 88f30cb..aaeb171 100644 --- a/docs/update_device-tree.md +++ b/docs/update_device-tree.md @@ -1,3 +1,7 @@ + + # Using a flash with the camera The Pi's camera module includes an LED flash driver which can be used to illuminate a scene upon capture. The flash driver has two configurable GPIO pins: diff --git a/flows/README.md b/flows/README.md index 806ce97..d50aca3 100644 --- a/flows/README.md +++ b/flows/README.md @@ -1 +1,5 @@ + + The files present here are Node-RED flows easily shared via this `json` format. diff --git a/hardware/HAT/PlanktoscopeHat-v0.1-fab-BOM.md b/hardware/HAT/PlanktoscopeHat-v0.1-fab-BOM.md index a263cde..461f738 100644 --- a/hardware/HAT/PlanktoscopeHat-v0.1-fab-BOM.md +++ b/hardware/HAT/PlanktoscopeHat-v0.1-fab-BOM.md @@ -1,3 +1,7 @@ + + | Qty | Value | Device | Package | Parts | Description | MPN | Order Link | Alternative MPN | Alternative Order Link | | :-: | ------------------ | ---------------------------- | -------------------- | ------------------------------- | ------------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------- | | 1 | 1.2nF | Capacitor Ceramic | 0805 | C13 | Ceramic Capacitors | C0805C122K5RACTU | | | diff --git a/scripts/README.md b/scripts/README.md index af46d2a..b752894 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,3 +1,7 @@ + + # Python scripts of the PlanktoScope This directory contains the various scripts needed for the PlanktoScope to run properly.