Skip to content

preparing to add Org in the repo name #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 20, 2021
Merged

preparing to add Org in the repo name #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c340e51
preparing to add Org in the repo name
FoamyGuy Jun 5, 2021
196c8b6
rename repo to include org inside docs/index.rst
FoamyGuy Jun 5, 2021
9026921
newline before pypi section in readme. fix pypi link target
FoamyGuy Jun 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Introduction
:alt: Discord


.. image:: https://github.com/circuitpython/CircuitPython_DisplayIO_Annotation/workflows/Build%20CI/badge.svg
:target: https://github.com/circuitpython/CircuitPython_DisplayIO_Annotation/actions
.. image:: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/workflows/Build%20CI/badge.svg
:target: https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/actions
:alt: Build Status


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At line 37 below, a newline is needed before 'Installing from PyPI'
At line 42 below, remove the adafruit-

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to check in on this back when it happened. Thanks for looking this over and catching those!

Expand All @@ -34,12 +34,14 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.Installing from PyPI
`circup <https://github.com/adafruit/circup>`_.

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-displayio_annotation/>`_.
PyPI <https://pypi.org/project/circuitpython-displayio_annotation/>`_.
To install for current user:

.. code-block:: shell
Expand Down Expand Up @@ -72,7 +74,7 @@ Contributing
============

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

Documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Table of Contents
.. toctree::
:caption: Other Links

Download <https://github.com/circuitpython/CircuitPython_DisplayIO_Annotation/releases/latest>
Download <https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation/releases/latest>
CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
Discord Chat <https://adafru.it/discord>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
long_description=long_description,
long_description_content_type="text/x-rst",
# The project's main homepage.
url="https://github.com/circuitpython/CircuitPython_DisplayIO_Annotation.git",
url="https://github.com/circuitpython/CircuitPython_Org_DisplayIO_Annotation.git",
# Author details
author="CircuitPython Organization",
author_email="",
Expand Down