Skip to content

Commit

Permalink
Extend README.rst and add CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ioshchepkov committed Mar 18, 2019
1 parent c725ed1 commit 25b3d29
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 5 deletions.
56 changes: 56 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. highlight:: shell

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/opengrav/gmeterpy/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

gMeterPy could always use more documentation, whether as part of the
official gMeterPy docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/opengrav/gmeterpy/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome :)

54 changes: 49 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,56 @@
gravps
======
========
gMeterPy
========

Gravity processing software framework in Python.
.. image:: https://img.shields.io/gitter/room/opengrav/gmeterpy.svg
:target: https://gitter.im/opengrav/gmeterpy
:alt: Chat room on Gitter

The project is in the early planning and development stage.

Gravity (small `g`) measurement data processing framework written in Python.

The goal of the gMeterPy is to create an open source software to process
raw data from all types of gravimeters.

**The project is in the early planning and development stage.**

About
-----
*gMeterPy* is an open source and free Python library for processing
measurement data from gravimeters, which are used for gravity field surveys
in geodesy, geophysics and other branches of Earth and planetary sciences.
The main intention is to go as deep as possible in processing **raw** data
from scratch, as well as to support all types of instruments,
corrections, common file formats and processing procedures.

Install
-------

To install ``gMeterPy`` simply use ``pip`` as usual:

.. code:: bash
pip install gmeterpy
Or with `git`:

.. code:: bash
git clone https://github.com/opengrav/gmeterpy.git && cd gmeterpy
pip install .
Contributing
------------

There are many ways you can contribute! Please read
`CONTRIBUTING.rst <https://github.com/opengrav/gmeterpy/blob/master/CONTRIBUTING.rst>`__
to see how you can help and give feedback.

License
-------

This project is licensed under the MIT License - see the LICENSE.txt file for details
This project is licensed under the MIT license.
Please see `LICENSE.txt <https://github.com/opengrav/gmeterpy/blob/master/LICENSE.txt>`__
for details.

0 comments on commit 25b3d29

Please sign in to comment.