Update readme.

This commit is contained in:
Robert Smallshire
2015-05-05 17:37:40 +02:00
parent a80a4282ac
commit aab5ebb81b
+10 -3
View File
@@ -2,6 +2,8 @@
Segpy 2
=======
Segpy is open source software created by Sixty North and licensed under the GNU Affero General Public License.
Status
======
@@ -10,6 +12,9 @@ Build status: rewrite branch:
.. image:: https://travis-ci.org/rob-smallshire/segpy.svg?branch=rewrite
:target: https://travis-ci.org/rob-smallshire/segpy
Segpy is alpha software but is usable in its current form. That said you should expect minor breaking API changes
between now and official release of a Segpy 2.
What is Segpy?
==============
@@ -20,9 +25,11 @@ non-profit organization.
This project aims to implement an open SEG Y module in Python for transporting seismic data between SEG Y files and
Python data structures in pure Python.
Segpy Versions
==============
Segpy 2.0 is a complete re-imagining of a SEG Y reader in Python and represents a complete break from the older
Segpy 1.0 in terms of the interface it presents to clients and the implementation behind those interfaces.
Segpy 1.0 should be considered unmaintained legacy software. The present and future of Segpy is Segpy 2.
Segpy 2.0 is a complete re-imagining of a SEG Y reader in Python and represents a complete break from all older versions
of Segpy. No attempt has been made to maintain API compatibility with earlier versions of Segpy and no code is shared
across versions. Although earlier versions of Segpy were open source, they were never 'released' as such. Earlier
versions of Segpy are considered deprecated and completely unsupported.