adafruit-mirror/Adafruit_CircuitPython_FruitJam
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
foamyguy 2025-05-02 11:47:30 -05:00
parent bfe28d04cd
commit bcedf6a527
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.rst
View file

@ -38,18 +38,10 @@ or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_. `circup <https://github.com/adafruit/circup>`_.
`Fruit Jam will be available from the Adafruit shop <http://www.adafruit.com/products/>`_
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
image from the assets folder in the PCB's GitHub repo.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
Installing from PyPI Installing from PyPI
===================== =====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-fruitjam/>`_. PyPI <https://pypi.org/project/adafruit-circuitpython-fruitjam/>`_.
@ -100,8 +92,16 @@ Or the following command to update an existing version:
Usage Example Usage Example
============= =============
.. todo:: Add a quick, simple example. It and other examples should live in the .. code-block:: python
examples folder and be included in docs/examples.rst.
import supervisor
from adafruit_fruitjam.peripherals import request_display_config
print(f"Display is None ? {supervisor.runtime.display is None}")
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
request_display_config(360, 200)
print(f"size: {supervisor.runtime.display.width}, {supervisor.runtime.display.height}")
Documentation Documentation
============= =============