Fix broken internal links and use apt over apt-get

This commit is contained in:
Ben Nuttall
2017-03-10 15:05:33 +00:00
parent 8c2264566a
commit d846d5b2bd
5 changed files with 42 additions and 34 deletions

View File

@@ -8,7 +8,7 @@ Table of Contents
recipes recipes
notes notes
contributing installing
api_input api_input
api_output api_output
api_spi api_spi
@@ -22,5 +22,6 @@ Table of Contents
remote_gpio remote_gpio
recipes_advanced recipes_advanced
recipes_remote_gpio recipes_remote_gpio
contributing
changelog changelog
license license

View File

@@ -2,39 +2,39 @@
Installing GPIO Zero Installing GPIO Zero
==================== ====================
GPIO Zero is installed by default in `Raspbian Jessie`_ and `PIXEL x86`_, available GPIO Zero is installed by default in `Raspbian Jessie`_ and `PIXEL x86`_,
from `raspberrypi.org`_. Follow these guides to installing on other operating available from `raspberrypi.org`_. Follow these guides to installing on other
systems, including for PCs using the :doc:`remote_gpio` feature. operating systems, including for PCs using the :doc:`remote_gpio` feature.
Raspberry Pi Raspberry Pi
============ ============
First, update your repositories list:: First, update your repositories list::
sudo apt-get update sudo apt update
Then install the package for Python 3:: Then install the package for Python 3::
sudo apt-get install python3-gpiozero sudo apt install python3-gpiozero
or Python 2:: or Python 2::
sudo apt-get install python-gpiozero sudo apt install python-gpiozero
Linux Linux
===== =====
First, update your distribution's repositories list. For example:: First, update your distribution's repositories list. For example::
sudo apt-get update sudo apt update
Then install pip for Python 3:: Then install pip for Python 3::
sudo apt-get install python3-pip sudo apt install python3-pip
or Python 3:: or Python 3::
sudo apt-get install python-pip sudo apt install python-pip
(Alternatively, install pip with `get-pip`_.) (Alternatively, install pip with `get-pip`_.)
@@ -75,8 +75,8 @@ Next, install gpiozero with pip::
pip install gpiozero pip install gpiozero
.. Raspbian Jessie_: https://www.raspberrypi.org/downloads/raspbian/ .. _Raspbian Jessie: https://www.raspberrypi.org/downloads/raspbian/
.. PIXEL x86_: https://www.raspberrypi.org/blog/pixel-pc-mac/ .. _PIXEL x86: https://www.raspberrypi.org/blog/pixel-pc-mac/
.. raspberrypi.org_: https://www.raspberrypi.org/downloads/ .. _raspberrypi.org: https://www.raspberrypi.org/downloads/
.. get-pip_: https://pip.pypa.io/en/stable/installing/ .. _get-pip: https://pip.pypa.io/en/stable/installing/
.. GitHub: https://github.com/RPi-Distro/python-gpiozero/issues .. _GitHub: https://github.com/RPi-Distro/python-gpiozero/issues

View File

@@ -82,15 +82,15 @@ version of gpiozero is available in your Python environment like so::
>>> require('gpiozero')[0].version >>> require('gpiozero')[0].version
'1.2.0' '1.2.0'
If you have multiple versions installed (e.g. from ``pip`` and ``apt-get``) If you have multiple versions installed (e.g. from ``pip`` and ``apt``) they
they will not show up in the list returned by the ``require`` method. However, will not show up in the list returned by the ``require`` method. However, the
the first entry in the list will be the version that ``import gpiozero`` will first entry in the list will be the version that ``import gpiozero`` will
import. import.
If you receive the error "No module named pkg_resources", you need to install If you receive the error "No module named pkg_resources", you need to install
the ``pip`` utility. This can be done with the following command in Raspbian:: the ``pip`` utility. This can be done with the following command in Raspbian::
$ sudo apt-get install python-pip $ sudo apt install python-pip
Alternatively, install pip with `get-pip`_. Alternatively, install pip with `get-pip`_.

View File

@@ -1,6 +1,6 @@
================ ==================
Recipes (Simple) Recipes (Advanced)
================ ==================
.. currentmodule:: gpiozero .. currentmodule:: gpiozero

View File

@@ -25,7 +25,7 @@ If you're using Raspbian Jessie (desktop - not Jessie Lite) then you have
everything you need to use the remote GPIO feature. If you're using Jessie Lite, everything you need to use the remote GPIO feature. If you're using Jessie Lite,
or another distribution, you'll need to install pigpio:: or another distribution, you'll need to install pigpio::
sudo apt-get install pigpio sudo apt install pigpio
Then you just need to enable **Remote GPIO** in the Raspberry Pi configuration Then you just need to enable **Remote GPIO** in the Raspberry Pi configuration
tool: tool:
@@ -38,6 +38,13 @@ Then launch the pigpio daemon::
sudo pigpiod sudo pigpiod
To only allow connections from a specific IP address, use the ``-n`` flag. For
example:
sudo pigpiod -n localhost # allow localhost only
sudo pigpiod -n 192.168.1.65 # allow 192.168.1.65 only
sudo pigpiod -n localhost -n 192.168.1.65 # allow localhost and 192.168.1.65 only
You will need to launch the pigpio daemon every time you wish to use this You will need to launch the pigpio daemon every time you wish to use this
feature. To automate running the daemon at boot time: feature. To automate running the daemon at boot time:
@@ -48,23 +55,23 @@ Preparing the host computer
If the host computer is a Raspberry Pi running Raspbian Jessie (or a PC running If the host computer is a Raspberry Pi running Raspbian Jessie (or a PC running
x86 PIXEL), then you have everything you need. If you're using another Linux x86 PIXEL), then you have everything you need. If you're using another Linux
distribution, Mac OS or Windows then you'll need to install the pigpio Python distribution, Mac OS or Windows then you'll need to install the ``pigpio``
library on the PC. Python library on the PC.
Raspberry Pi Raspberry Pi
------------ ------------
First, update your repositories list:: First, update your repositories list::
sudo apt-get update sudo apt update
Then install the pigpio library for Python 3:: Then install the pigpio library for Python 3::
sudo apt-get install python3-pigpio sudo apt install python3-pigpio
or Python 2:: or Python 2::
sudo apt-get install python-pigpio sudo apt install python-pigpio
Alternatively, install with pip:: Alternatively, install with pip::
@@ -79,15 +86,15 @@ Linux
First, update your distribution's repositories list. For example:: First, update your distribution's repositories list. For example::
sudo apt-get update sudo apt update
Then install pip for Python 3:: Then install pip for Python 3::
sudo apt-get install python3-pip sudo apt install python3-pip
or Python 2:: or Python 2::
sudo apt-get install python-pip sudo apt install python-pip
(Alternatively, install pip with `get-pip`_.) (Alternatively, install pip with `get-pip`_.)
@@ -224,6 +231,6 @@ Pi Zero
??? ???
.. RPi.GPIO_: https://pypi.python.org/pypi/RPi.GPIO .. _RPi.GPIO: https://pypi.python.org/pypi/RPi.GPIO
.. pigpio_: http://abyz.co.uk/rpi/pigpio/python.html .. _pigpio: http://abyz.co.uk/rpi/pigpio/python.html
.. get-pip_: https://pip.pypa.io/en/stable/installing/ .. _get-pip: https://pip.pypa.io/en/stable/installing/