Skip to content
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

switch to pip for dependency installation #208

Merged
merged 2 commits into from
Oct 4, 2023
Merged

switch to pip for dependency installation #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae03d42
switch to pip for dependency installation
grvvy Jun 22, 2023
92bd5c0
Update pyproject authors entry
miek Oct 3, 2023
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
17 changes: 9 additions & 8 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@ Currently, the LUNA library is considered a “work-in-progress”; and
thus it’s assumed you’ll want to use a local copy of LUNA for
development.

The easiest way to set this up is to install the distribution in a virtual environment.
The easiest way to set this up is to install the distribution in your working environment.
From the root of the repository:

.. code:: sh

# Pull down poetry, our build system.
pip3 install poetry --user
# Install a copy of our local tools.
pip install .

# Install a copy of our local tools into our virtualenv.
poetry install
# Alternatively: install all dependencies,
# including optional development packages (required for running applets and examples).
pip install .[dev]


If you want to install LUNA to your machine globally (not recommended), you can do so
Expand All @@ -48,7 +49,7 @@ using the following single command:
.. code:: sh

# Create a LUNA package, and install it.
pip3 install . --user
pip install . --user


Testing
Expand All @@ -62,11 +63,11 @@ program gateware using Amaranth HDL; so they can be run like any other script:

# With GSG or self-built LUNA hardware connected; we can run the full test,
# and test both our installation and the attached hardware.
poetry run applets/interactive-test.py
python applets/interactive-test.py

# Without LUNA hardware connected, we'll only build the applet, to exercise
# our toolchain.
poetry run applets/interactive-test.py --dry-run
python applets/interactive-test.py --dry-run


The ``apollo`` utility.
Expand Down
Loading