Update the README #365
Update the README #365
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #365 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 2757 2757
=========================================
Hits 2757 2757 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Peter Sobolewski <[email protected]>
There was a problem hiding this comment.
This is awesome @willingc, thank you for the massive improvement! I left a couple of comments 😊
|
|
||
| 1. Create and activate a virtual environment. | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Do we think it's better to link here to our virtual environments guide: https://napari.org/stable/plugins/virtual_environment_docs/1-virtual-environments.html
I can see how we might just want a quickstart so feel free to take or leave this suggestion!
There was a problem hiding this comment.
Let's do this. Let's add the documentation link below the quickstart commands.
In general, I like to keep all installation steps together instead of linking out to other docs. Installation is the first experience users have with the repo, and we want them to be successful.
There was a problem hiding this comment.
Added an italicized note to with the suggested guide. 👍🏼
Co-authored-by: Draga Doncila Pop <[email protected]>
|
Thanks for the review @DragaDoncila. I've incorporated your suggestions. ☀️ |
Co-authored-by: Peter Sobolewski <[email protected]>
psobolewskiPhD
added
the
ready to merge
DragaDoncila
removed
the
ready to merge
This PR updates the README.md to be more user-friendly. The PR:
I was trying to understand the technical architecture of the plugin engine and created this to help me with my own understanding. Thought it might be helpful for others too.
Closes #263.