Skip to content

Commit

Permalink
Merge pull request #125 from IMMM-SFA/feature/python-versions-badge
Browse files Browse the repository at this point in the history
add python version badge, fix developer workflow
  • Loading branch information
thurber authored Dec 18, 2024
2 parents 65eda50 + d24ca33 commit 7f11404
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[![test](https://github.com/IMMM-SFA/msd_uncertainty_ebook/actions/workflows/01_test.yml/badge.svg)](https://github.com/IMMM-SFA/msd_uncertainty_ebook/actions/workflows/01_test.yml) [![deploy](https://github.com/IMMM-SFA/msd_uncertainty_ebook/actions/workflows/02_deploy.yml/badge.svg)](https://github.com/IMMM-SFA/msd_uncertainty_ebook/actions/workflows/02_deploy.yml) [![codecov](https://codecov.io/gh/IMMM-SFA/msd_uncertainty_ebook/branch/dev/graph/badge.svg?token=sc7PduW907)](https://codecov.io/gh/IMMM-SFA/msd_uncertainty_ebook)
[![PyPI version](https://badge.fury.io/py/msdbook.svg)](https://badge.fury.io/py/msdbook)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/msdbook)](https://pypi.org/project/msdbook/)


## Addressing Uncertainty in [MultiSector Dynamics](https://climatemodeling.science.energy.gov/program-area/multisector-dynamics) Research

Expand All @@ -11,12 +13,4 @@ Merges to `main` will automatically compile, release, and deploy the ebook.

### Developer Workflow

To develop `msd_uncertainty_ebook`, follow the [GitHub workflow](https://docs.github.com/en/get-started/using-github/github-flow), note that you may have to fork the repository. First clone the repo, then:

```console
$ cd PATH/TO/DIR
$ pip install -e .
$ pre-commit install
```

You're now ready to create your own branch and start developing!
Follow the [UC eBook Development Workflow](https://uc-ebook.org/dev/docs/html/contributing.html#development-workflow), which broadly follows the [GitHub workflow](https://docs.github.com/en/get-started/using-github/github-flow).

0 comments on commit 7f11404

Please sign in to comment.