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.

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

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

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

Conversation

cHemingway
Copy link

Source for this being the correct way: https://libera.irclog.whitequark.org/amaranth-lang/2023-09-21

@cHemingway cHemingway requested a review from whitequark as a code owner June 10, 2024 19:21
Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.10%. Comparing base (496432e) to head (aaa56af).
Report is 29 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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@whitequark
Copy link
Member

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.

@cHemingway
Copy link
Author

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.

@whitequark
Copy link
Member

Take a look at https://github.com/amaranth-lang/template-fpga, it could be a useful starting point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants