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 readmes #845

Merged
merged 10 commits into from
Mar 12, 2024
Merged

update readmes #845

merged 10 commits into from
Mar 12, 2024

Conversation

casperdcl
Copy link
Member

@casperdcl casperdcl commented Oct 31, 2023

Copy link
Member

@KrisThielemans KrisThielemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for this.

Copy link
Contributor

@paskino paskino left a 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.

@casperdcl casperdcl changed the title readme update re-enable CCPi-Regularisation, update readme Oct 31, 2023
@casperdcl casperdcl self-assigned this Oct 31, 2023
@KrisThielemans
Copy link
Member

@paskino @casperdcl what's the status of this one?

@casperdcl
Copy link
Member Author

going to split this out into separate PRs

@casperdcl casperdcl changed the title re-enable CCPi-Regularisation, update readme update readmes Mar 8, 2024
@casperdcl
Copy link
Member Author

@KrisThielemans ready for review :)

@casperdcl casperdcl requested a review from KrisThielemans March 8, 2024 21:11
Copy link
Member

@KrisThielemans KrisThielemans left a 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
Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop MATLAB here

@KrisThielemans KrisThielemans added this to the v3.6 milestone Mar 9, 2024
Copy link
Member

@KrisThielemans KrisThielemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please merge.

@KrisThielemans KrisThielemans merged commit 1110e10 into master Mar 12, 2024
@KrisThielemans KrisThielemans deleted the readme-update branch March 12, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README clean-up, mostly on docker Check the readme file for out of date information
3 participants