README.rst

   1 Introduction
   2 ============
   3
   4 .. image:: https://readthedocs.org/projects/adafruit-blinka-displayio/badge/?version=latest
   5     :target: https://adafruit-blinka-displayio.readthedocs.io/en/latest/
   6     :alt: Documentation Status
   7
   8 .. image:: https://img.shields.io/discord/327254708534116352.svg
   9     :target: https://adafru.it/discord
  10     :alt: Discord
  11
  12 .. image:: https://github.com/adafruit/Adafruit_Blinka_Displayio/workflows/Build%20CI/badge.svg
  13     :target: https://github.com/adafruit/Adafruit_Blinka_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 Blinka <https://github.com/adafruit/Adafruit_Blinka>`_
  28
  29 Installing from PyPI
  30 =====================
  31
  32 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
  33 PyPI <https://pypi.org/project/adafruit-blinka-displayio/>`_. To install for current user:
  34
  35 .. code-block:: shell
  36
  37     pip3 install adafruit-blinka-displayio
  38
  39 To install system-wide (this may be required in some cases):
  40
  41 .. code-block:: shell
  42
  43     sudo pip3 install adafruit-blinka-displayio
  44
  45 To install in a virtual environment in your current project:
  46
  47 .. code-block:: shell
  48
  49     mkdir project-name && cd project-name
  50     python3 -m venv .env
  51     source .env/bin/activate
  52     pip3 install adafruit-blinka-displayio
  53
  54 Contributing
  55 ============
  56
  57 Contributions are welcome! Please read our `Code of Conduct
  58 <https://github.com/adafruit/Adafruit_blinka_CircuitPython_displayio/blob/master/CODE_OF_CONDUCT.md>`_
  59 before contributing to help this project stay welcoming.
  60
  61 To make sure your pull request will pass the commit checks, use pre-commit to check your code formatting. Please see the guide page here for more details: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github/check-your-code
  62
  63 Documentation
  64 =============
  65
  66 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>`_.