-
Notifications
You must be signed in to change notification settings - Fork 9
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
Changes from round of JOSS review #428
Conversation
- Add discussion of sanity checks to getting started - Make build/bin more consistent in documentation - Add comment about python path - Make sure figures display in all browsers by making png versions
Co-authored-by: Christoph Junghans <[email protected]>
doc/sphinx/src/getting-started.rst
Outdated
cmake -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF .. | ||
make -j | ||
make install # optional: install into directory defined via CMAKE_INSTALL_PREFIX | ||
cmake -B builddir -S . -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON -DSINGULARITY_BUILD_TESTS=ON |
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 think that this buildidir
should be build
? just like the ones on line 13 and 14. I saw there was a change in name and probably that one was forgotten.
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.
Correct, my mistake!
doc/sphinx/src/getting-started.rst
Outdated
cmake --build build --parallel | ||
cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX |
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.
cmake --build build --parallel | |
cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX | |
cmake --build builddir --parallel | |
cmake --install builddir # optional: install into directory defined via CMAKE_INSTALL_PREFIX |
…ts from getting started.
Changed things back to |
PR Summary
This is to address comments in #427 . Thanks @guadabsb15 for the suggestions!
PR Checklist
make format
command after configuring withcmake
.If preparing for a new release, in addition please check the following:
when='@main'
dependencies are updated to the release version in the package.py