forked from platformio/platformio-core
Remove SCons from docs, etc.
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,6 +2,5 @@
|
|||||||
*.pyc
|
*.pyc
|
||||||
.pioenvs
|
.pioenvs
|
||||||
.tox
|
.tox
|
||||||
.sconsign.dblite
|
|
||||||
docs/_build
|
docs/_build
|
||||||
dist
|
dist
|
||||||
|
@ -143,7 +143,6 @@ same for the all projects, don't need to modify them):
|
|||||||
InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
|
InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
|
||||||
InstallPip $env:PYTHON_HOME
|
InstallPip $env:PYTHON_HOME
|
||||||
InstallPackage $env:PYTHON_HOME setuptools
|
InstallPackage $env:PYTHON_HOME setuptools
|
||||||
InstallPackage $env:PYTHON_HOME scons
|
|
||||||
InstallPackage $env:PYTHON_HOME platformio
|
InstallPackage $env:PYTHON_HOME platformio
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ Please fill all fields for your project in the Drone control panel:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
|
pip install -U platformio
|
||||||
platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
|
platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
|
||||||
|
|
||||||
.. image:: ../_static/droneci-platformio-integration-1.png
|
.. image:: ../_static/droneci-platformio-integration-1.png
|
||||||
@ -75,7 +75,7 @@ Examples
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
|
pip install -U platformio
|
||||||
wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
|
wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
|
||||||
unzip /tmp/spi4teensy3.zip -d /tmp
|
unzip /tmp/spi4teensy3.zip -d /tmp
|
||||||
platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
|
platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
|
||||||
|
@ -55,7 +55,7 @@ GitHub repository.
|
|||||||
- PLATFORMIO_CI_SRC=path/to/source/directory
|
- PLATFORMIO_CI_SRC=path/to/source/directory
|
||||||
|
|
||||||
install:
|
install:
|
||||||
- python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
|
- pip install -U platformio
|
||||||
|
|
||||||
script:
|
script:
|
||||||
- platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
|
- platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
|
||||||
@ -81,7 +81,7 @@ Examples
|
|||||||
- PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
|
- PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
|
||||||
|
|
||||||
install:
|
install:
|
||||||
- python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
|
- pip install -U platformio
|
||||||
- wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
|
- wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
|
||||||
- unzip /tmp/spi4teensy3.zip -d /tmp
|
- unzip /tmp/spi4teensy3.zip -d /tmp
|
||||||
|
|
||||||
|
51
docs/faq.rst
51
docs/faq.rst
@ -103,53 +103,6 @@ Troubleshooting
|
|||||||
Installation
|
Installation
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
``SCons`` is not installed in your system
|
|
||||||
'''''''''''''''''''''''''''''''''''''''''
|
|
||||||
|
|
||||||
PlatformIO depends on awesome and irreplaceable software construction tool
|
|
||||||
named `SCons <http://www.scons.org>`_. PlatformIO Code Builder uses it to build
|
|
||||||
single source code for the multiple embedded platforms.
|
|
||||||
|
|
||||||
When you install PlatformIO it tries to find ``scons`` program in your OS. If
|
|
||||||
SCons is installed in your system, then PlatformIO will use it. Otherwise,
|
|
||||||
PlatformIO tries to install it automatically using ``pip install scons``. So, if
|
|
||||||
you are here, then it means that PlatformIO could not install it for you.
|
|
||||||
Let fix it manually.
|
|
||||||
|
|
||||||
1. Need to cleanup all previous SCons installations using `pip <https://pip.pypa.io>`_
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
[sudo] pip uninstall scons
|
|
||||||
|
|
||||||
|
|
||||||
2. Try to install it manually
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
[sudo] pip install scons
|
|
||||||
|
|
||||||
# If you have errors:
|
|
||||||
# * error: option --single-version-externally-managed not recognized
|
|
||||||
# * OSError: [Errno 1] Operation not permitted: '/System/Library/Frameworks/Python.framework/Versions/2.7/man'
|
|
||||||
[sudo] pip install --egg scons --install-option="--no-install-man"
|
|
||||||
|
|
||||||
3. If it didn't help you, try system OS package manager
|
|
||||||
|
|
||||||
* **Mac OS X** using `SCons Mac OS X Installer <https://github.com/rviney/scons-mac-installer>`_
|
|
||||||
or `brew <http://brew.sh>`_ (``brew install scons``)
|
|
||||||
* **Linux** ``[sudo] apt-get install scons`` or ``[sudo] yum install scons``
|
|
||||||
|
|
||||||
To identify that SCons is installed in your system run ``scons -v``.
|
|
||||||
|
|
||||||
|
|
||||||
.. _faq_troubleshooting_sconssingverextmanaged:
|
|
||||||
|
|
||||||
PIP & SCons Error: option --single-version-externally-managed not recognized
|
|
||||||
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
|
||||||
|
|
||||||
Answered in `issue #279 <https://github.com/platformio/platformio/issues/279>`_.
|
|
||||||
|
|
||||||
[Errno 1] Operation not permitted
|
[Errno 1] Operation not permitted
|
||||||
'''''''''''''''''''''''''''''''''
|
'''''''''''''''''''''''''''''''''
|
||||||
|
|
||||||
@ -181,8 +134,8 @@ For example, ``which platformio`` is equal to ``/usr/local/bin/platformio``,
|
|||||||
then `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_
|
then `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_
|
||||||
should contain ``/usr/local/bin`` directory.
|
should contain ``/usr/local/bin`` directory.
|
||||||
|
|
||||||
**Unix Users**: You can make "symlinks" from ``platformio`` and ``scons``
|
**Unix Users**: You can make "symlinks" from ``platformio`` program to the
|
||||||
programs to the ``bin`` directory which is included in ``$PATH``. For example,
|
``bin`` directory which is included in ``$PATH``. For example,
|
||||||
see `issue #272 <https://github.com/platformio/platformio/issues/272#issuecomment-133626112>`_.
|
see `issue #272 <https://github.com/platformio/platformio/issues/272#issuecomment-133626112>`_.
|
||||||
|
|
||||||
Windows UnicodeDecodeError: 'ascii' codec can't decode byte
|
Windows UnicodeDecodeError: 'ascii' codec can't decode byte
|
||||||
|
@ -34,7 +34,7 @@ System requirements
|
|||||||
**Windows Users**: Please `Download the latest Python 2.7.x
|
**Windows Users**: Please `Download the latest Python 2.7.x
|
||||||
<https://www.python.org/downloads/>`_ and install it.
|
<https://www.python.org/downloads/>`_ and install it.
|
||||||
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
|
**DON'T FORGET** to select ``Add python.exe to Path`` feature on the
|
||||||
"Customize" stage.
|
"Customize" stage, otherwise ``pip`` command will not be available.
|
||||||
|
|
||||||
:Terminal Application:
|
:Terminal Application:
|
||||||
|
|
||||||
@ -56,19 +56,20 @@ The latest stable version of PlatformIO may be installed or upgraded via
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# update package installer
|
|
||||||
pip install -U pip setuptools
|
|
||||||
|
|
||||||
# install or upgrade PlatformIO
|
|
||||||
pip install -U platformio
|
pip install -U platformio
|
||||||
|
|
||||||
Note that you may run into permissions issues running these commands. You have
|
Note that you may run into permissions issues running these commands. You have
|
||||||
a few options here:
|
a few options here:
|
||||||
|
|
||||||
* Run with ``sudo`` to install PlatformIO and dependencies globally
|
* Run with ``sudo`` to install PlatformIO and dependencies globally
|
||||||
|
* Specify the `pip install --user <https://pip.pypa.io/en/stable/user_guide.html#user-installs>`_
|
||||||
|
option to install local to your user
|
||||||
* Run the command in a `virtualenv <https://virtualenv.pypa.io>`_ local to a
|
* Run the command in a `virtualenv <https://virtualenv.pypa.io>`_ local to a
|
||||||
specific project working set.
|
specific project working set.
|
||||||
|
|
||||||
|
If ``pip`` command is not available or you have problems with it try
|
||||||
|
:ref:`installation_installer_script`.
|
||||||
|
|
||||||
.. _installation_installer_script:
|
.. _installation_installer_script:
|
||||||
|
|
||||||
b) Installer Script
|
b) Installer Script
|
||||||
@ -129,10 +130,6 @@ c) Full Guide
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# update package installer
|
|
||||||
pip install -U pip setuptools
|
|
||||||
|
|
||||||
# install or upgrade PlatformIO
|
|
||||||
pip install -U platformio
|
pip install -U platformio
|
||||||
|
|
||||||
If your computer does not recognize ``pip`` command, try to install it first
|
If your computer does not recognize ``pip`` command, try to install it first
|
||||||
@ -151,8 +148,8 @@ Install the latest PlatformIO from the ``develop`` branch:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# update package installer
|
# uninstall existing version
|
||||||
pip install -U pip setuptools
|
pip uninstall platformio
|
||||||
|
|
||||||
# install the latest development version of PlatformIO
|
# install the latest development version of PlatformIO
|
||||||
pip install -U https://github.com/platformio/platformio/archive/develop.zip
|
pip install -U https://github.com/platformio/platformio/archive/develop.zip
|
||||||
|
Reference in New Issue
Block a user