diff --git a/README.md b/README.md index 3a22d6a6..cb7a98c7 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,15 @@ We welcome contributions to the Acquire code base and to documentation. Refer to ## Build -To build the website locally and serve it, run the following commands: +To build the website locally and serve it, after cloning and successfully installing `acquire-imaging` and +`acquire-zarr` in developer mode, run the following commands: ```bash pip install -r requirements.txt mkdocs serve ``` + +> [!NOTE] +> This setup assumes you have acquire-python and acquire-zarr cloned in the same +> parent directory as acquire-docs. If this is not the case, edit the +> [`mkdocs.yml` file](https://github.com/acquire-project/acquire-docs/blob/main/mkdocs.yml) accordingly. diff --git a/docs/stream_to_zarr/index.md b/docs/stream_to_zarr/index.md new file mode 100644 index 00000000..f967acff --- /dev/null +++ b/docs/stream_to_zarr/index.md @@ -0,0 +1,28 @@ +--- +title: Stream to Zarr +template: home_zarr.html +--- + +
The Acquire Zarr Streaming library supports chunked, compressed, multiscale streaming to + Zarr, with + OME-NGFF metadata.
+ + Get Started + +