Skip to content

Commit

Permalink
[ENH] Structure README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
slumnitz committed Aug 18, 2020
1 parent cdf182d commit 706e93d
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,46 @@
# BioPAL Governance
# BioPAL Governance

The purpose of this repository is to formalize the governance process of the BioPAL project.
This document clarifies how decisions are made
and how the various elements of our community interact, including the relationship between
open source collaborative development and work that may be funded by for-profit or non-profit entities.

The governance documents are best-viewed at our website: [WEBISTE:TBA]

## Table of Contents

* [Main Governance Document](governance.md)
* [Current Steering Council and Institutional Partners](people.md)
* [Code of Conduct](conduct/code_of_conduct.md)

## License of Governance Documents

See [the governance introduction](intro.md) for license information.

## Infrastructure for this repository

The content in this repository is hosted online with `github-pages`, and the HTML
files are built with [jupyter-book](https://jupyterbook.org). To build and preview
these documents locally, install the latest version of Jupyter Book with:

```
pip install -U git+https://github.com/executablebooks/jupyter-book.git
```

and build the book with:

```
cd path/to/this/repo
jupyter-book build .
```

The resulting website will be in `_build/html`, which you can explore by opening
any of the `.html` files that are created.

## Governance history

TBD

## Acknowledgments

Substantial portions of this document were adapted from the Jupyter/IPython project’s [governance document](https://github.com/jupyter/governance).

0 comments on commit 706e93d

Please sign in to comment.