diff --git a/README.md b/README.md index e7e5de80..311a1cc6 100644 --- a/README.md +++ b/README.md @@ -21,23 +21,21 @@ the Python open source tools that drive open science. We do this through: pyOpenSci is an independent organization, fiscally sponsored by Community Initiatives. -:construction: Construction note :construction: - -This repository is currently under heavy construction. So please note that if -you are working through the content! - ## Contributing statement ## How to setup -This repository contains the source files for the [pyOpenSci governance](https://pyopensci.org/governance). +This repository contains the source files for the [pyOpenSci Python packaging guide](https://pyopensci.org/python-package-guide). + +## Build the guidebook locally -## Build the governance document locally +Our guidebook is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool and uses the pydata-sphinx-theme. -Our governance documentation is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool. +The easiest way to build our documentation is to use [the `nox` automation tool](https://nox.thea.codes/), +a tool for quickly building environments and running +commands within them. -The easiest way to build our documentationis to use [the `nox` automation tool](https://nox.thea.codes/), a tool for quickly building environments and running commands within them. Using `nox` ensures that your environment has all the dependencies needed to build the documentation. To build, follow these steps: @@ -64,8 +62,8 @@ $ nox -s docs-live ## Contributing to this guide -We welcome and issues and pull-requests to improve the content of this guide. -If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/governance/issues/new/choose). +We welcome and issues and pull requests to improve the content of this guide. +If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/python-package-guide/issues/new/choose). ## Contributors ✨