Skip to content

Commit

Permalink
Update README.md (#193)
Browse files Browse the repository at this point in the history
* Update README.md

- Add common sections to doc
- Fix 404 docs link
- Expand NAP2 description

* Add link to constructor project

* Add link to constructor and packaging  in napari docs

* Add link to constructor docs

* Add comment about target user

* Add tests CI badge

* Add tests UI status badge

* Comment out usage pending questions

* Apply suggestions from @psobolewski code review

Co-authored-by: Peter Sobolewski <[email protected]>

---------

Co-authored-by: Peter Sobolewski <[email protected]>
  • Loading branch information
willingc and psobolewskiPhD authored Nov 4, 2024
1 parent 90a0e80 commit cf24e73
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# napari packaging
# packaging - conda-based napari installers

This repository stores the CI pipelines and helper scripts needed to create conda-based napari installers for Linux, macOS and Windows.
[![tests](https://github.com/napari/packaging/actions/workflows/tests.yml/badge.svg)](https://github.com/napari/packaging/actions/workflows/tests.yml)
[![tests_ui](https://github.com/napari/packaging/actions/workflows/tests_ui.yml/badge.svg)](https://github.com/napari/packaging/actions/workflows/tests_ui.yml)

**Important: This repo is used by napari core maintainers.**

## Description

This repository stores the tools (CI pipelines and helper scripts) needed to create **conda-based**
napari installers for Linux, macOS and Windows. It uses the [constructor](https://github.com/conda/constructor)
tool which allows [constructing an installer](https://conda.github.io/constructor/) for a collection
of conda packages.

## Documentation

You can find more information in the following resources:

* [Napari docs about packaging](https://napari.org/stable/developers/packaging.html)
* [NAP-2](https://napari.org/dev/naps/2-conda-based-packaging.html)
* [Napari docs about packaging](https://napari.org/dev/developers/coredev/packaging.html)
* [Napari docs about creating installers using this repo and the constructor tool](https://napari.org/dev/developers/coredev/packaging.html#installers)
* [NAP-2: Distributing napari with conda-based packaging](https://napari.org/stable/naps/2-conda-based-packaging.html)

<!---
## Usage
TODO: add basics
-->

0 comments on commit cf24e73

Please sign in to comment.