/ README.rst
README.rst
 1  Introduction
 2  ============
 3  
 4  
 5  .. image:: https://readthedocs.org/projects/circuitpython-slider/badge/?version=latest
 6      :target: https://circuitpython-slider.readthedocs.io/en/latest/?badge=latest
 7      :alt: Documentation Status
 8  
 9  
10  .. image:: https://github.com/jposada202020/CircuitPython_slider/workflows/Build%20CI/badge.svg
11      :target: https://github.com/jposada202020/CircuitPython_slider/actions
12      :alt: Build Status
13  
14  .. image:: https://img.shields.io/pypi/v/circuitpython-slider.svg
15      :alt: latest version on PyPI
16      :target: https://pypi.python.org/pypi/circuitpython-slider
17  
18  .. image:: https://static.pepy.tech/personalized-badge/circuitpython-slider?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
19      :alt: Total PyPI downloads
20      :target: https://pepy.tech/project/circuitpython-slider
21  
22  
23  .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
24      :target: https://github.com/psf/black
25      :alt: Code Style: Black
26  
27  slider widget to work with non discrete values in touch resistive screens
28  
29  
30  Dependencies
31  =============
32  This driver depends on:
33  
34  * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
35  
36  Please ensure all dependencies are available on the CircuitPython filesystem.
37  This is easily achieved by downloading
38  `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
39  or individual libraries can be installed using
40  `circup <https://github.com/adafruit/circup>`_.
41  
42  Usage Example
43  =============
44  
45  .. image:: https://raw.githubusercontent.com/jposada202020/CircuitPython_slider/main/docs/slider.png
46  
47  
48  Please see the ``slider_simpletest.py`` example for initial reference