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.

Sign up for GitHub

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

Jump to bottom

Add Basic Documentation to README.md #8

Open
tavaughan opened this issue Oct 19, 2017 · 4 comments
Open

Add Basic Documentation to README.md #8

tavaughan opened this issue Oct 19, 2017 · 4 comments
Assignees
@lassoan
Labels
enhancement

Comments

@tavaughan
Copy link
Collaborator

At minimum:

  • A brief 1-paragraph description of what the module does
  • A few screenshots showing the main features
  • Use cases
  • Explanation of input options, parameters, etc.
@tavaughan tavaughan changed the title Add Documentation to README.md Add Basic Documentation to README.md Oct 19, 2017
tavaughan added a commit to tavaughan/SlicerMarkupsToModel that referenced this issue Oct 26, 2017
@tavaughan
ENH: Added screenshots for documentation, see SlicerIGT#8
8674fcb
tavaughan added a commit to tavaughan/SlicerMarkupsToModel that referenced this issue Oct 26, 2017
@tavaughan
ENH: Updated README.md as per SlicerIGT#8
78662f4
lassoan pushed a commit that referenced this issue Oct 26, 2017
@tavaughan @lassoan
ENH: Added screenshots for documentation, see #8
b42c066
lassoan pushed a commit that referenced this issue Oct 26, 2017
@tavaughan @lassoan
ENH: Updated README.md as per #8
fef5df4
@tavaughan tavaughan reopened this Oct 26, 2017
@tavaughan
Copy link
Collaborator Author

@lassoan Do we have any nice screenshots of use cases?

@lassoan
Copy link
Contributor

lassoan commented Oct 26, 2017

You can add some for LumpNav and your catheter tracking. I'll get some heart annulus contours.

@tavaughan tavaughan assigned tavaughan and lassoan and unassigned tavaughan Oct 26, 2017
@tavaughan
Copy link
Collaborator Author

@lassoan I added tumor segmentation and catheter reconstruction use cases. If you have anything else you want to add, please do :-). If not, please close this ticket.

@tavaughan
Copy link
Collaborator Author

@lassoan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lassoan lassoan

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lassoan @tavaughan