Skip to content

Commit

Permalink
docs: move firmware info from readme to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Rafael Silva <perigoso@riseup.net>
  • Loading branch information
perigoso committed Nov 22, 2021
1 parent 0227cc2 commit bbfc687
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 22 deletions.
8 changes: 0 additions & 8 deletions README.md
Expand Up @@ -13,14 +13,6 @@ for more information.
- 2.4GHz radio
- smol, but not that smol

## Firmware

The plan:

The device will need two firmwares, nrf52 will be updated through a spi bootloader by the main mcu, which will be updated through hid

Both will include debug header

## License

This hardware is licensed under the [CERN-OHL-P v2](LICENSE) license.
37 changes: 23 additions & 14 deletions docs/index.rst
Expand Up @@ -5,6 +5,24 @@ russian-woodpecker
******************
*russian-woodpecker* is a usb HS (capable of 8kHz polling rate) 2.4GHz radio receiver dongle for use with input devices

State of the project
====================

First prototype.

.. admonition:: Roadmap

- Initial design |:+1:|
- First prototype manufactured and assembled |:hammer:|
- Barebones firmware support
- Documentation |:hammer:|
- Hardware improvements / V1

========== ================
|:+1:| Done!
|:hammer:| Work in progress
========== ================

Specifications
==============

Expand All @@ -24,23 +42,14 @@ Hardware
* USB C connector
* External antenna connector

State of the project
====================

First prototype.
Firmware
========

.. admonition:: Roadmap
The plan:

- Initial design |:+1:|
- First prototype manufactured and assembled |:hammer:|
- Barebones firmware support
- Documentation |:hammer:|
- Hardware improvements / V1
The device will need two firmwares, nrf52 will be updated through a spi bootloader by the main mcu, which will be updated through hid

========== ================
|:+1:| Done!
|:hammer:| Work in progress
========== ================
Both will include debug header


.. toctree::
Expand Down

0 comments on commit bbfc687

Please sign in to comment.