README.rst

   1 Introduction
   2 ============
   3
   4 .. image:: https://readthedocs.org/projects/adafruit-blinka-circuitpython-displayio/badge/?version=latest
   5     :target: https://circuitpython.readthedocs.io/projects/displayio/en/latest/
   6     :alt: Documentation Status
   7
   8 .. image:: https://img.shields.io/discord/327254708534116352.svg
   9     :target: https://discord.gg/nBQh6qu
  10     :alt: Discord
  11
  12 .. image:: https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/workflows/Build%20CI/badge.svg
  13     :target: https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/actions
  14     :alt: Build Status
  15
  16 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  17     :target: https://github.com/psf/black
  18     :alt: Code Style: Black
  19
  20 displayio for Blinka
  21
  22
  23 Dependencies
  24 =============
  25 This driver depends on:
  26
  27 * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
  28
  29 Please ensure all dependencies are available on the CircuitPython filesystem.
  30 This is easily achieved by downloading
  31 `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
  32
  33 Installing from PyPI
  34 =====================
  35 .. note:: This library is not available on PyPI yet. Install documentation is included
  36    as a standard element. Stay tuned for PyPI availability!
  37
  38 .. todo:: Remove the above note if PyPI version is/will be available at time of release.
  39    If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
  40
  41 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
  42 PyPI <https://pypi.org/project/adafruit-circuitpython-displayio/>`_. To install for current user:
  43
  44 .. code-block:: shell
  45
  46     pip3 install adafruit-circuitpython-displayio
  47
  48 To install system-wide (this may be required in some cases):
  49
  50 .. code-block:: shell
  51
  52     sudo pip3 install adafruit-circuitpython-displayio
  53
  54 To install in a virtual environment in your current project:
  55
  56 .. code-block:: shell
  57
  58     mkdir project-name && cd project-name
  59     python3 -m venv .env
  60     source .env/bin/activate
  61     pip3 install adafruit-circuitpython-displayio
  62
  63 Usage Example
  64 =============
  65
  66 .. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
  67
  68 Contributing
  69 ============
  70
  71 Contributions are welcome! Please read our `Code of Conduct
  72 <https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/blob/master/CODE_OF_CONDUCT.md>`_
  73 before contributing to help this project stay welcoming.
  74
  75 Documentation
  76 =============
  77
  78 For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.