diff --git a/PYPI_README.md b/PYPI_README.md new file mode 100644 index 0000000..00bdd12 --- /dev/null +++ b/PYPI_README.md @@ -0,0 +1,16 @@ +# NeuroPose + +3D human pose estimation pipeline for clinical movement research, +built on [MeTRAbs](https://github.com/isarandi/metrabs). + +**Status:** pre-release. This is the reserved PyPI name for the +upcoming 0.1.0 release. The first public release is in preparation — +it will land with an accompanying engineering paper (JOSS submission). + +- **Source:** +- **License:** MIT +- **Authors:** Liqi Shu, Levi Neuwirth, David Man, Praneeth Tummala + (Brown University, Shu Lab) + +Until 0.1.0 ships, `pip install neuropose` will resolve to nothing +useful; wait for the release announcement at the source URL above. diff --git a/pyproject.toml b/pyproject.toml index 8ce14c7..b0bc531 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "hatchling.build" name = "neuropose" version = "0.1.0.dev0" description = "3D human pose estimation pipeline for clinical movement research, built on MeTRAbs." -readme = "README.md" +readme = "PYPI_README.md" license = { file = "LICENSE" } requires-python = ">=3.11,<3.12" authors = [