Skip to content

Commit

Permalink
Add information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tekktrik committed Feb 22, 2024
1 parent 2dd1d03 commit 5491694
Showing 1 changed file with 54 additions and 2 deletions.
56 changes: 54 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ circfirm
:target: https://github.com/tekktrik/circfirm/actions
:alt: GitHub Actions Workflow Status

.. image:: https://codecov.io/gh/tekktrik/circfirm/graph/badge.svg?token=UM67L1VZZ1
.. image:: https://codecov.io/gh/tekktrik/circfirm/graph/badge.svg?token=UM67L1VZZ1
:target: https://codecov.io/gh/tekktrik/circfirm
:alt: Codecov Report

Expand All @@ -21,4 +21,56 @@ circfirm
:target: https://pypi.org/project/circfirm/
:alt: PyPI - Downloads

A CLI tool for updating the firmware for CircuitPython boards
A CLI tool for updating the firmware for CircuitPython boards

Installation
============

The best way to install ``circfirm`` is by using [``pipx``](https://github.com/pypa/pipx),
which creates an isolated virtual environment for the dependencies:

.. code-block:: shell
pipx install circfirm
You can also just use ``pip`` to install it, if the dependencies won't cause issues:

.. code-block:: shell
pip install circfirm
Usage
=====

The follow commands show some of the functionality of ``circfirm``:

.. code-block:: shell
# Install a version of CircuitPython to a connected board
circfirm install 8.0.0
# Install a version of CircuitPython in French to a connected board
circfirm install 8.0.0 --language fr
# List all the cached (previously downloaded) CircuitPython versions
circfirm cache list
# List all the cached CircuitPython versions for a speciic board
circfirm cache list --board feather_m4_express
# Save a version of CircuitPython to the cache
# (You can also use the --language option here)
circfirm cache save feather_m4_express 8.0.0
# Clear the cached CircuitPython versions
circfirm cache clear
# You can use --board, --version, and --language options to further specify
# what firmwares should be cleared - this clears version 7.0.0 firmwares for
# all boards and in all languages
circfirm cache clear --version 7.0.0
# See help/information about circfirm or any specific command using --help
circfirm --help
circfirm install --help
circfirm cache save --help

0 comments on commit 5491694

Please sign in to comment.