Skip to content

Update install.rst to specify how to install board definitions #1380

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update install.rst to specify how to install board definitions #1380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,10 @@ Editable development snapshot
Installing board definitions
=============================

.. todo::
This must be installed directly from github:

Explain how to install `<https://github.com/amaranth-lang/amaranth-boards>`_.
.. code-block:: console

$ pip install "amaranth-boards @ git+https://github.com/amaranth-lang/amaranth-boards.git"

This is not to be confused with the PyPI package `amaranth_boards <https://pypi.org/project/amaranth-boards/>`_ which is currently a placeholder.