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

ENH: update and reformat README #1750

Merged
merged 98 commits into from
May 23, 2024
Merged

ENH: update and reformat README #1750

merged 98 commits into from
May 23, 2024

Conversation

ncullen93
Copy link
Member

This proposed PR updates and reformats the README. It is best to view it visually on my fork at https://github.com/ncullen93/ANTs instead of the raw file.

Improvements:

  • You don't have to leave the readme to learn how to install ANTs in a basic scenario.
  • All learning resources are grouped together so when I’m in “learning mode” I can quickly evaluate which one I need.
  • Same with scripts / example code that are now grouped a bit more semantically.
  • For references, article titles are displayed so I can quickly evaluate which are relevant rather than having to follow a ton of links that take me away from the readme.
  • In general, it's much clearer now when you're nevigating to a script, to a tutorial, or to a journal article. It was a complete lottery what I’m going to get from the links on the current Readme.
  • In general, links that take users away from the repo should be minimized… they’ll get distracted and never come back.
  • Links to outdated (e.g., source forge) or unfinished resources are all removed

@ntustison
Copy link
Member

Hey @ncullen93 , I think that looks very good. I would obviously update the team list to include yourself and probably level the listing so that everybody's in the bulleted list or in a single sentence. I'd probably also add a recent paper but I can do that after your merge.

@stnava
Copy link
Member

stnava commented May 20, 2024

thanks for this

perhaps link to the wiki some where https://github.com/ANTsX/ANTs/wiki

@ncullen93
Copy link
Member Author

@ntustison I updated the team section and agree it would be nice for you to update or add references eventually.

@stnava Great idea - the ANTs Wiki is now the first link under the "Learning Resources" section.

Feel free to give more feedback or merge and then make any changes you want.

@cookpa cookpa merged commit 658c200 into ANTsX:master May 23, 2024
1 check passed
@cookpa
Copy link
Member

cookpa commented May 23, 2024

Merging in anticipation of next release (ITK 5.4.0 is about to be announced)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants