-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add contributing file and sections in readme
- Loading branch information
1 parent
a293ecb
commit 1cd653a
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Contributing to *polytope* | ||
======================================== | ||
|
||
Please report bug_ reports or pull-requests_ on GitHub_ | ||
|
||
.. _bug: https://github.com/ecmwf/polytope/issues | ||
|
||
.. _pull-requests: https://github.com/ecmwf/polytope/pulls | ||
|
||
.. _GitHub: https://github.com/ecmwf/polytope | ||
|
||
We want your feedback, please e-mail: [email protected] | ||
|
||
The package is installed from PyPI with:: | ||
|
||
$ pip install polytope-python | ||
|
||
How you could use polytope: | ||
* plot outputs, examples are provided in the examples folder | ||
* go further than our examples and let us know how it goes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters