amaranth
amaranth copied to clipboard
Update install.rst to specify how to install board definitions
Source for this being the correct way: https://libera.irclog.whitequark.org/amaranth-lang/2023-09-21
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 91.10%. Comparing base (496432e) to head (aaa56af).
:warning: Report is 146 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #1380 +/- ##
==========================================
+ Coverage 90.99% 91.10% +0.10%
==========================================
Files 45 45
Lines 11218 11315 +97
Branches 2429 2768 +339
==========================================
+ Hits 10208 10308 +100
+ Misses 831 830 -1
+ Partials 179 177 -2
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
I'm aware that this is a pain point for new users of Amaranth but I'm also not sure if the current installation page is what we should continue to present, given that it only works in a virtual environment if you're on a modern Linux system (Debian, Ubuntu, WSL 2). It's possible that the right thing to do is to recommend using PDM, but it might also not be.
I'm not going to merge this within the 0.5 release cycle but we should definitely look into improving installation instructions for the 0.6 release cycle.
I found this particular step worked for me on a MacBook, using a venv but not pdm.
Other steps didn't, (I needed to set some environmental variables to point out the toolchain and my current hack of doing this via setting os.environ is not ideal) so I can see why you would want to just rewrite the installation guide instead.
Take a look at https://github.com/amaranth-lang/template-fpga, it could be a useful starting point.