-
Notifications
You must be signed in to change notification settings - Fork 18
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 readmes #845
update readmes #845
Conversation
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.
thanks for this.
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.
GCC and CMake versions and info on what's built with CIL is outdated.
@paskino @casperdcl what's the status of this one? |
going to split this out into separate PRs |
@KrisThielemans ready for review :) |
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.
Great! some minor suggestions and one big one: let's cut out MATLAB here. I've moved some info to the wiki page, so let's clean this up here as indicated.
README.md
Outdated
cmake --build . --config Release | ||
|
||
```sh | ||
cmake --build ./build --config Release | ||
``` | ||
|
||
Note that there is no separate install step. | ||
|
||
### MATLAB and Python conflicts |
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.
delete this whole section. I've moved it to
https://github.com/SyneRBI/SIRF/wiki/SIRF-and-MATLAB
README.md
Outdated
|
||
This `USE_SYSTEM_*` function can be used for as many or as few packages as desired. Advantages to building against your own version of certain packages are decreased compilation times and the potential to use newer versions of these packages. | ||
|
||
However, we have only tested SIRF with the versions of the required dependencies that are built by default in the Superbuild. If you decide to compile SIRF using system versions of the dependencies, you run a greater risk of something going wrong. | ||
However, we have only tested SIRF with the versions of the required dependencies that are built by default in the SuperBuild. If you decide to compile SIRF using system versions of the dependencies, you run a greater risk of something going wrong. | ||
|
||
For this reason, we advise new SIRF users to compile with all the `USE_SYSTEM_*` options disabled. If you decide to use system versions of certain packages, we would be interested to hear about it any compatibility issues that you may run into. | ||
|
||
### Python and MATLAB installation locations |
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.
drop MATLAB here
mostly related to MATLAB
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.
Please merge.
re-enable CCPi-Regularisationmoved to CCPi regularisation fails test #832