From ccc511a735433b9fa0af9b4279f6aa134e4e5873 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 17 Oct 2019 19:38:56 -0400 Subject: [PATCH 1/3] Removed building locally section from README, replaced with documentation section --- README.rst | 49 +++---------------------------------------------- 1 file changed, 3 insertions(+), 46 deletions(-) diff --git a/README.rst b/README.rst index 7f83dde..1ec1fae 100644 --- a/README.rst +++ b/README.rst @@ -62,50 +62,7 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -Building locally -================ - -To build this library locally you'll need to install the -`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 - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rtttl --library_location . - -Sphinx documentation ------------------------ - -Sphinx is used to build the documentation based on rST files and comments in the code. First, -install dependencies (feel free to reuse the virtual environment from above): - -.. code-block:: shell - - python3 -m venv .env - source .env/bin/activate - pip install Sphinx sphinx-rtd-theme - -Now, once you have the virtual environment activated: - -.. code-block:: shell - - cd docs - sphinx-build -E -W -b html . _build/html - -This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to -view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass. +Documentation +============= +For information on building library documentation, please check out `this guide `_. From 9a07833555bbb065a0fe3e01053c9cb065aaf7e3 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 10:58:59 -0400 Subject: [PATCH 2/3] Added pypi installation instructions --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index 1ec1fae..a7597ac 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,26 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +Installing from PyPI +==================== + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + pip3 install adafruit-circuitpython-rtttl +To install system-wide (this may be required in some cases): + +.. code-block:: shell + sudo pip3 install adafruit-circuitpython-rtttl +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-rtttl + Usage Example ============= From e971c5dba3fbf78c72bb25147f98097ad9c97f8f Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 22 Oct 2019 20:17:41 -0400 Subject: [PATCH 3/3] Fixed spacing --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index a7597ac..b5884f5 100644 --- a/README.rst +++ b/README.rst @@ -34,14 +34,19 @@ On supported GNU/Linux systems like the Raspberry Pi, you can install the driver PyPI `_. To install for current user: .. code-block:: shell + pip3 install adafruit-circuitpython-rtttl + To install system-wide (this may be required in some cases): .. code-block:: shell + sudo pip3 install adafruit-circuitpython-rtttl + 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