Skip to content

Commit 85b753f

Browse files
committed
Adding badge
1 parent a7df180 commit 85b753f

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# epanet-python
2-
Is home for Python packages related to the EPANET engine.
2+
Is home for Python packages related to the EPANET engine.
3+
34

45
## Build Status
56
[![Build status](https://ci.appveyor.com/api/projects/status/lrm84lry4p9obwl6/branch/dev?svg=true)](https://ci.appveyor.com/project/michaeltryby/epanet-python/branch/dev)
67

8+
[![Coverage Status](https://coveralls.io/repos/github/michaeltryby/epanet-python/badge.svg?branch=dev)](https://coveralls.io/github/michaeltryby/epanet-python?branch=dev)
9+
10+
711
## Contents
812
* epanet-module - A ctypes based wrapper for the EPANET Toolkit (with support for reading EPANET binary output files).
9-
* epanet-python - SWIG based wrappers for the EPANET Toolkit and Output libraries.
13+
* epanet-python - SWIG based wrappers for the EPANET Toolkit and Output libraries.
1014
* ...
1115

16+
1217
## Motivation
1318
These Python wrappers for EPANET are available to developers interested in building higher level functionality on top. Starting with a clean, auto-generated python API wrapper is a good foundation for building more abstractions. This also intersects with the near-term needs of the GUI work (which uses python and QT) - SWIG-wrapping will mean that the epanet library becomes scriptable from within the GUI.
1419

1520
Another benefit of auto-generating the wrapper is that it's fairly unambiguous; nobody's personal preferences get involved until we get to slightly higher-level abstractions, but everyone can share and benefit from the foundational SWIG layer.
1621

22+
1723
## Contributing
18-
There are many ways for those interested in contributing to participate - providing software development support, helping with documentation, finding bugs, or contributing feature requests. Feel free to get involved!
24+
There are many ways for those interested in contributing to participate - providing software development support, helping with documentation, finding bugs, or contributing feature requests. Feel free to get involved!

0 commit comments

Comments
 (0)