Skip to content

Commit

Permalink
README.rst: Update installing from source section
Browse files Browse the repository at this point in the history
This section was outdated as we have moved to pyproject.toml.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
  • Loading branch information
pdgendt authored and marc-hb committed Sep 20, 2024
1 parent 49f0a10 commit 08d0329
Showing 1 changed file with 2 additions and 21 deletions.
23 changes: 2 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,16 +117,11 @@ Installing from Source
~~~~~~~~~~~~~~~~~~~~~~

You can create and install a wheel package to install west as well.
The `wheel`_ Python package is required to do this. See "Installing Wheel"
below if you need to do this.

To build the west wheel file::

# macOS, Linux
python3 setup.py bdist_wheel

# Windows
py -3 setup.py bdist_wheel
pip3 install --upgrade build
python -m build

This will create a file named ``dist/west-x.y.z-py3-none-any.whl``,
where ``x.y.z`` is the current version in setup.py.
Expand All @@ -137,17 +132,3 @@ To install the wheel::

You can ``pip3 uninstall west`` to remove this wheel before re-installing the
version from PyPI, etc.

Installing Wheel
~~~~~~~~~~~~~~~~

On macOS and Windows, you can install wheel with::

pip3 install wheel

That also works on Linux, but you may want to install wheel from your
system package manager instead -- e.g. if you installed pip from your
system package manager. The wheel package is likely named something
like ``python3-wheel`` in that case.

.. _wheel: https://wheel.readthedocs.io/en/latest/

0 comments on commit 08d0329

Please sign in to comment.