Skip to content

Removed building locally section from README, replaced with documentation section #17

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
kattni merged 2 commits into from
Oct 21, 2019
Merged

Removed building locally section from README, replaced with documentation section #17

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ba2433
Update README.rst
evaherrada Oct 17, 2019
d18eb06
Added PyPi installation instructions
evaherrada Oct 18, 2019
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
Next Next commit
Update README.rst
  • Loading branch information
@evaherrada
evaherrada authored Oct 17, 2019
commit 2ba2433f4f0955db51b94b30d112b86c087914cd
25 changes: 3 additions & 22 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,7 @@ Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DRV2605/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Building locally
================

To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.

.. code-block:: shell

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

.. code-block:: shell

source .env/bin/activate

Then run the build:

.. code-block:: shell
Documentation
=============

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-drv2605 --library_location .
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>`_.