[WIP] Chipping away at modernizing the Readme.md #283
Conversation
…ttempting to identify common questions/information users may want when first hitting the repo
… out features. May need to decrease image resolution.
…ing links to previously pushed GIFs
|
@swederik you can see the latest version at this URL: https://github.com/dannyrb/cornerstoneTools/blob/aca0daa782453ce5c4b02b1fa942a160ece2e1f4/README.md I'm curios to hear your thoughts on:
Hope I'm on the right track. |
…minimize vertical space
|
Really sorry about all of these "coveralls" notifications. The only good way to preview a layout is to make a commit and observe the changes. Latest can be found here: https://github.com/dannyrb/cornerstoneTools/blob/b4e90565f22841b40e7fe30320ea3a9a3bc59eef/README.md Bumped to 4 per row to allow for easier viewing on mobile. |
|
This looks awesome to me! I also love how the git branch is marked as a chore :-) Did you try Atom to preview the github-flavoured markdown? I also want to make coveralls less verbose. |
|
Haha, my org uses Good call out on using Atom! I actually use VS Code, but your comment reminded me to do some digging for a plugin: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-preview-github-styles 👍 Thanks (: I intend to:
And then I'll |
|
@swederik this should be ready for review. |
|
Looks good to me! Shall we merge it? |
README.md
Outdated
| View the [live examples](https://rawgithub.com/chafey/cornerstoneTools/master/examples/index.html) to see this | ||
| library in action! | ||
| * View [live examples](https://rawgithub.com/chafey/cornerstoneTools/master/examples/index.html) of individual tools | ||
| * Take a peak at a [simple image viewer](http://chafey.github.io/cornerstoneDemo/) built on cornerstone |
There was a problem hiding this comment.
I guess you mean peek, not peak?
|
Hah. My 2am coding is showing. I'll update this. If anything else jumps out
at you, please let me know.
…On Nov 29, 2017 10:24 AM, "Erik Ziegler" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In README.md
<#283 (comment)>
:
> a set of common tools needed in medical imaging to work with images and stacks of images.
-View the [live examples](https://rawgithub.com/chafey/cornerstoneTools/master/examples/index.html) to see this
-library in action!
+* View [live examples](https://rawgithub.com/chafey/cornerstoneTools/master/examples/index.html) of individual tools
+* Take a peak at a [simple image viewer](http://chafey.github.io/cornerstoneDemo/) built on cornerstone
I guess you mean peek, not peak?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#283 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFh21Hc34dm1uXghuNJ-CjkK5jCfzRynks5s7YU8gaJpZM4Qal7M>
.
|
|
Going to Please feel free to queue up any documentation items you'd like to see. I'm starting to work on a hit list that prioritizes informing contributors/extenders. |
@swederik working on that penance for my earlier accidental merge 🙏
Let me know if anything in here seems off, or if you'd like to see anything added.