Update README.md #125
Merged
Update README.md #125
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nclack
reviewed
Dec 4, 2023
README.md
Outdated
| Acquire also supports the following output file formats: | ||
|
|
||
| - [Tiff](https://en.wikipedia.org/wiki/TIFF) | ||
| - [Zarr](https://zarr.dev/) |
There was a problem hiding this comment.
Should mention this is OME-Zarr (for zarr v2) and Zarr v3.
README.md
Outdated
| - [Tiff](https://en.wikipedia.org/wiki/TIFF) | ||
| - [Zarr](https://zarr.dev/) | ||
|
|
||
| For testing and demonstration purposes, Acquire provides a few simulated cameras, as well as raw and trash output devices. | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
What do you think about moving the install instructions to the very top of the README? This may help clarify the acquire-imaging awkwardness.
Co-authored-by: Nathan Clack <nclack@gmail.com>
|
Thanks for the feedback, @nclack! I've updated the PR. |
nclack
reviewed
Dec 4, 2023
README.md
Outdated
|
|
||
| This python package provides a multi-camera video streaming library focusing | ||
| on performant microscopy. | ||
| ### Installation |
There was a problem hiding this comment.
Suggested change
| ### Installation | |
| ### Installation |
Lets just get rid of the heading. Alternatively could add an About heading before line 14.
There was a problem hiding this comment.
I think it looks better with Installation deleted than with having both Installation and About headings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating the README with copy from docs website and providing a link to the documentation.