-
Notifications
You must be signed in to change notification settings - Fork 171
Refactor README (reorder installation steps + color-formatting for commands) #375
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
Conversation
README.md
Outdated
Install required packages (Linux - 64 bit): | ||
|
||
sudo apt install binutils-dev zlib1g-dev | ||
```bash | ||
sudo apt install binutils-dev zlib1g-dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add zlib
into the Conda environment, that should take care of it.
The binutils
are currently needed for stacktraces on Linux --- I'd like to get rid of it and move fully to the same approach as macOS is using which does not require binutils, but I didn't have time to finish it yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add zlib into the Conda environment, that should take care of it.
Good point @certik, fixed it.
The binutils are currently needed for stacktraces on Linux --- I'd like to get rid of it and move fully to the same approach as macOS is using which does not require binutils, but I didn't have time to finish it yet.
That makes sense, I can work on this and create a separate PR if it is okay with you. :)
README.md
Outdated
cmake --build . -j16 | ||
```bash | ||
cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_LLVM=yes -DWITH_STACKTRACE=yes -DWITH_LFORTRAN_BINARY_MODFILES=no . | ||
cmake --build . -j$nproc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have $nproc
defined. Is the -j16
confusing?
We could switch to ninja, which runs in parallel by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be $nproc
doesnot work on Mac, the reason it was confusing to me was that I only had 8 cores in my CPU but it had hardcoded 16 in the readme, but I guess it wouldn't matter much as it will always take 8 cores if that's the maximum count.
I can revert this change, may be switching to ninja is an option but IMO not something thats needed right now.
Thanks! Very useful. |
Thanks! |
This PR updates the README, notably following changes have been made:
$nproc
instead of hard-coding16
in thecmake –build
command.cc: @certik