Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed May 26, 2023
1 parent ee27cb6 commit 8642d68
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.rst
Expand Up @@ -2,9 +2,17 @@

.. _README:

######
README
######
##########################
Hiveeyes Arduino Firmwares
##########################


.. image:: https://github.com/hiveeyes/arduino/actions/workflows/platformio-ci.yaml/badge.svg
:target: https://github.com/hiveeyes/arduino/actions/workflows/platformio-ci.yaml
:alt: PlatformIO CI outcome


[![PlatformIO CI](https://github.com/hiveeyes/arduino/actions/workflows/platformio-ci.yaml/badge.svg)](https://github.com/hiveeyes/arduino/actions/workflows/platformio-ci.yaml)

.. contents::
:local:
Expand Down Expand Up @@ -56,18 +64,18 @@ Get source code with all dependency libraries and tools::
Toolchain
=========

PlatformIO_ is the recommended build environment.
PlatformIO
----------
We recommend to use PlatformIO_. Installing all dependency libraries will be managed
automatically, accurately, and reproducibly, and you will be able to choose between
CLI and UI operations.

Arduino IDE
-----------
If you want to use the Arduino IDE, you have to install all necessary libraries manually.
In each programs subdirectory, there is a ``platformio.ini`` which will give you a clue
about the libraries to use.

PlatformIO
----------
When using PlatformIO_, installing all dependency libraries will be managed automatically.


*******
Operate
Expand Down

0 comments on commit 8642d68

Please sign in to comment.