Skip to content

Commit

Permalink
docs(readme): Improve readme
Browse files Browse the repository at this point in the history
Hopefully this also triggers the SDK docs to rebuild
  • Loading branch information
chriswmackey committed Jan 20, 2021
1 parent bdfcd77 commit ae50b6b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -3,7 +3,7 @@
[![Build Status](https://github.com/ladybug-tools/dragonfly-uwg/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-uwg/actions)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-uwg/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-uwg)

[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-360/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# dragonfly-uwg

Expand All @@ -21,7 +21,7 @@ If you want to also include the command line interface try:

## QuickStart

```
```console
import dragonfly_uwg
```

Expand All @@ -30,7 +30,7 @@ import dragonfly_uwg
## Local Development

1. Clone this repo locally
```
```console
git clone git@github.com:ladybug-tools/dragonfly-uwg

# or
Expand All @@ -45,12 +45,12 @@ pip install -r requirements.txt
```

3. Run Tests:
```
```console
python -m pytest tests/
```

4. Generate Documentation:
```
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_uwg
sphinx-build -b html ./docs ./docs/_build/docs
```

0 comments on commit ae50b6b

Please sign in to comment.