From 6c917f81502e6730e6d6a4b7fb2b8190f7dd2491 Mon Sep 17 00:00:00 2001 From: Rafael Silva Date: Mon, 22 Nov 2021 15:54:58 +0000 Subject: [PATCH] readme: remove documentation that is now on readthedocs Signed-off-by: Rafael Silva --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9b819e9..ecf1330 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,18 @@ # russian-woodpecker +[![Documentation Status](https://readthedocs.org/projects/russian-woodpecker/badge/?version=latest)](https://openinput.readthedocs.io/projects/russian-woodpecker/en/latest/?badge=latest) + [](https://github.com/openinput-fw) -the "russian woodpecker" is a usb HS (capable of 8kHz polling rate) 2.4GHz radio receiver dongle for use with input devices +*russian-woodpecker* is a usb HS (capable of 8kHz polling rate) 2.4GHz radio receiver dongle for use with input devices +Please see the [documentation](https://russian-woodpecker.readthedocs.io/en/latest) +for more information. ## Specifications - 8 kHz polling rate suppor - 2.4GHz radio -- integrated USB A dongle thingy - smol, but not that smol -## Hardware - -![russian woodpecker](docs/assets/r0.1-boardview.png) - -- ATSAMS3U MCU as main controller -- nrf52810 MCU as radio receiver - - SPI connection between MCUs -- USB A male connector - ## Firmware The plan: