From 78cd931f1a46b90d8ba62df0a739e707d0f43fb8 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Sat, 22 Jan 2022 02:51:15 -0500 Subject: [PATCH 1/2] README Refactor --- README.md | 63 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 45 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e42078a..55405f3 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,51 @@ -OpenROV -================ -[OpenROV](http://openrov.com/) is a DIY telerobotics community centered around underwater exploration & adventure. Our [forum](https://forum.openrov.com/) is the primary place for community interaction and we encourage you to join us there! -Introduction -------- -This repository contains the electronics files for the OpenROV DIY Kits. These include the schematics, gerbers and the other files + diagrams. +# OpenROV -Resources -------- -[Bill of Materials](https://docs.google.com/spreadsheet/ccc?key=0Avf6fUwp9B3kdF9YQWxBTnZjZEVGZVQwY25EbnVyREE&usp=sharing) +***DIY Telerobotics*** for ***Underwater Exploration*** *&* ***Adventure*** *.* -[Mechanical files](https://github.com/OpenROV/openrov-hardware) +If you want to take part in community
+interactions, head over to our **[Forum]** ! -Notes -------- -For OpenROV v2.6, v2.7, v2.8 see the OpenROV Controller Board Files. - >It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit the BeagleBone Black. +--- -For OpenROV v2.5 See the OpenROV Controller 2.5B. - >It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit both the BeagleBone Black and the original BeagleBone +**⸢ [Website] ⸥ ⸢ [Forum] ⸥ ⸢ [Bill of Materials] ⸥ ⸢ [Hardware Files] ⸥** -For OpenROV V2.3 and V2.4, see the BeagleBone Cape A1. - >It is a all-in one power and control board based around the Atmega 328. +--- + +## Contents + +This repository contains all files related
+to our **OpenROV DIY Kits**, these include
+`Schematics`, `Gerbers`, `Diagrams`, `..` + +--- + +## Releases + +**[`2.6`][2.6]** | **[`2.7`][2.7]** | **[`2.8`][2.8]** + +> It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit the BeagleBone Black. + +**[`2.5`][2.5]** + +> It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit both the BeagleBone Black and the original BeagleBone + + +**[`2.3`][2.3]** | **[`2.4`][2.4]** + +> It is a all-in one power and control board based around the Atmega 328. + + + + +[Website]: http://openrov.com/ +[Forum]: https://forum.openrov.com/ +[Hardware Files]: https://github.com/OpenROV/openrov-hardware +[Bill of Materials]: https://docs.google.com/spreadsheet/ccc?key=0Avf6fUwp9B3kdF9YQWxBTnZjZEVGZVQwY25EbnVyREE&usp=sharing + +[2.3]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 +[2.4]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 +[2.5]: ./OpenROV%20Controller%202.5B +[2.6]: ./OpenROV%20Controller%202.6 +[2.7]: ./OpenROV%20Controller%202.7%20Final%20Data%20Pkg +[2.8]: ./OpenROV%20Controller%202.8%20Final%20Data%20Pkg From 95fb83cdc9aa860312d6d349e53911be13235c62 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Thu, 11 Aug 2022 05:39:37 -0400 Subject: [PATCH 2/2] Formatted README --- README.md | 75 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 54 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 55405f3..2c2b320 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ +
+ +
+ # OpenROV ***DIY Telerobotics*** for ***Underwater Exploration*** *&* ***Adventure*** *.* -If you want to take part in community
-interactions, head over to our **[Forum]** ! +
+
---- +[![Button Website]][Website]    +[![Button Forum]][Forum]    +[![Button BOM]][BOM]    +[![Button Hardware]][Hardware] -**⸢ [Website] ⸥ ⸢ [Forum] ⸥ ⸢ [Bill of Materials] ⸥ ⸢ [Hardware Files] ⸥** +
---- +
+
## Contents @@ -18,34 +26,59 @@ This repository contains all files related
to our **OpenROV DIY Kits**, these include
`Schematics`, `Gerbers`, `Diagrams`, `..` ---- +
+
## Releases -**[`2.6`][2.6]** | **[`2.7`][2.7]** | **[`2.8`][2.8]** +
+ +- **[`2.6`]**  |  **[`2.7`]**  |  **[`2.8`]** + + All-in-one power and control board that
+ has a Arduino based  `Atmega 2560`  board. + + Tons of I/O and designed to
+ fit the  `BeagleBone Black` . + +
-> It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit the BeagleBone Black. +- **[`2.5`]** -**[`2.5`][2.5]** + All-in-one power & control board that has
+ a Arduino based  `Atmega 2560`  board. + + Tons of I/O and designed to fit both
+ `BeagleBone`  &  `BeagleBone Black` . -> It is a all-in-one power and control board that has an Arduino based Atmega 2560 aboard. Tons of I/O, and is designed to fit both the BeagleBone Black and the original BeagleBone +
+- **[`2.3`]**  |  **[`2.4`]** -**[`2.3`][2.3]** | **[`2.4`][2.4]** + All-in-one power & control board
+ based around the  `Atmega 328` . -> It is a all-in one power and control board based around the Atmega 328. +
+[Hardware]: https://github.com/OpenROV/openrov-hardware [Website]: http://openrov.com/ [Forum]: https://forum.openrov.com/ -[Hardware Files]: https://github.com/OpenROV/openrov-hardware -[Bill of Materials]: https://docs.google.com/spreadsheet/ccc?key=0Avf6fUwp9B3kdF9YQWxBTnZjZEVGZVQwY25EbnVyREE&usp=sharing - -[2.3]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 -[2.4]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 -[2.5]: ./OpenROV%20Controller%202.5B -[2.6]: ./OpenROV%20Controller%202.6 -[2.7]: ./OpenROV%20Controller%202.7%20Final%20Data%20Pkg -[2.8]: ./OpenROV%20Controller%202.8%20Final%20Data%20Pkg +[BOM]: https://docs.google.com/spreadsheet/ccc?key=0Avf6fUwp9B3kdF9YQWxBTnZjZEVGZVQwY25EbnVyREE&usp=sharing + +[`2.3`]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 +[`2.4`]: ./OpenROV%20BeagleBone%20Cape%20Rev%20A1%20v2.3%20v2.4 +[`2.8`]: ./OpenROV%20Controller%202.8%20Final%20Data%20Pkg +[`2.7`]: ./OpenROV%20Controller%202.7%20Final%20Data%20Pkg +[`2.5`]: ./OpenROV%20Controller%202.5B +[`2.6`]: ./OpenROV%20Controller%202.6 + + + + +[Button Hardware]: https://img.shields.io/badge/Hardware-81B441?style=for-the-badge&logoColor=white&logo=GodotEngine +[Button Website]: https://img.shields.io/badge/Website-1293D8?style=for-the-badge&logoColor=white&logo=GoogleChrome +[Button Forum]: https://img.shields.io/badge/Forum-782A90?style=for-the-badge&logoColor=white&logo=ElasticStack +[Button BOM]: https://img.shields.io/badge/Bill_Of_Material-E04E39?style=for-the-badge&logoColor=white&logo=Docs.rs