adafruit-mirror/Adafruit_CircuitPython_framebuf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
51 commits 6 branches 40 tags 352 KiB
Python 100%
Find a file
Carter Nelson 97aefe39db
Merge pull request #26 from caternuson/iss25 
Add except to catch small int overflow
2019-11-02 23:03:02 -07:00
docs Initial setup. 2018-12-21 14:41:15 -06:00
examples Added a function to clear the buffer 2019-10-20 20:02:34 -04:00
utils add font, text support. binary font file saves 1KB RAM, we just reference it as a file! (code moved from unsupported https://github.com/adafruit/micropython-adafruit-bitmap-font to here) 2018-12-21 21:02:01 -05:00
.gitignore PyPI setup. 2018-12-22 15:34:05 -06:00
.pylintrc Initial setup. 2018-12-21 14:41:15 -06:00
.readthedocs.yml Initial setup. 2018-12-21 14:41:15 -06:00
.travis.yml PyPI setup. 2018-12-22 15:34:05 -06:00
adafruit_framebuf.py catch small int overflow 2019-11-02 22:02:17 -07:00
CODE_OF_CONDUCT.md Initial setup. 2018-12-21 14:41:15 -06:00
LICENSE Initial setup. 2018-12-21 14:41:15 -06:00
README.rst Removed building locally section from README, replaced with documentation section 2019-10-17 20:19:09 -04:00
requirements.txt Initial setup. 2018-12-21 14:41:15 -06:00
setup.py Finish setup.py 2018-12-22 15:35:51 -06:00

README.rst 

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-framebuf/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/framebuf/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_framebuf.svg?branch=master
    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_framebuf
    :alt: Build Status

CircuitPython frambuf module, based on the Python frambuf module.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
--------------------

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-framebuf/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-framebuf

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-framebuf

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-framebuf

Usage Example
=============

See example in /examples/framebuf_simpletest.py

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_framebuf/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

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>`_.