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
Updated user guide introduction for nmigen. #24
Comments
Comment by codecov[bot] Codecov Report
@@ Coverage Diff @@
## master #22 +/- ##
==========================================
+ Coverage 82.3% 85.87% +3.57%
==========================================
Files 34 28 -6
Lines 5565 4063 -1502
Branches 1190 818 -372
==========================================
- Hits 4580 3489 -1091
+ Misses 852 480 -372
+ Partials 133 94 -39
Continue to review full report at Codecov.
|
Comment by eilims Howdy! Following these commands will correctly install the package:
This ensures that all packages can be found by the installer as pulling the repository and attempting to run the setup.py locally using python3 will result in missing packages (notably Python.h) I was installing nmigen today and may have pulled out a hair or two and just wanted to make everyone's life a little easier! |
Comment by sam-falvo Thank you for the feedback. I'd missed this. I'll probably be able to commit your recommended changes in a day or two, unless by some miracle I find the free time later tonight. :) |
Comment by sam-falvo I decided to make the change without mentioning Ubuntu or Debian specifically. Not all Linux distributions use a distinct pip3 executable (I use Void Linux, for instance, and at least within a virtualenv configured to use Python 3, pip and pip3 are identical executables). I'll be pushing the change shortly. Apologies for the long latency; the start-up that I work for has had me well and truly burnt out for a while. |
Comment by peteut @sam-falvo It should not be possible to install nMigen on unsupported Python versions anyway, should be constrained using [1] https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires |
Comment by sam-falvo Wouldn't >=3.6 be preferred? On Thu, Feb 21, 2019 at 8:45 AM Alain Péteut notifications@github.com
-- |
Comment by peteut
Indeed, |
@sam-falvo Thank you for your effort. Ultimately I decided to completely rewrite the manual for nMigen, with both different style and end goals. The current (quite unfinished but already useful) manual is available at https://nmigen.info/nmigen/. @eilims You might find the new installation page useful: https://nmigen.info/nmigen/latest/install.html |
Issue by sam-falvo
Sunday Jan 06, 2019 at 20:02 GMT
Originally opened as m-labs/nmigen#22
The goal is to work through each section, one by one, receiving documentation reviews along the way. The introduction is a good first step. Feedback appreciated!
sam-falvo included the following code: https://github.com/m-labs/nmigen/pull/22/commits
The text was updated successfully, but these errors were encountered: