[segyio] 13/376: Project goal section.

[Jørgen Kvalsvik]

This is an automated email from the git hooks/post-receive script.

jokva-guest pushed a commit to branch debian
in repository segyio.

commit 72a7461756ef6cbb2708bd492e44957a7d7c149a
Author: Jørgen Kvalsvik <jokva at statoil.com>
Date:   Thu Oct 6 09:15:56 2016 +0200

    Project goal section.
---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index bac34c6..7fcb781 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,24 @@ contributions of all kinds are very welcome.
  * Read and write traces, trace headers.
  * Easy to use and native-feeling python interface with numpy integration.
 
+## Project goals ##
+
+Segyio does necessarily attempt to be the end-all of SEG-Y interactions;
+rather, we aim to lower the barrier to interacting with SEG-Y files for
+embedding, new applications or free-standing programs.
+
+Additionally, the aim is not to support the full standard or all exotic (but
+correctly) formatted files out there. Some assumptions are made, such as:
+
+ * All traces in a file are assumed to be of the same sample size.
+ * It is assumed all lines have the same number of traces.
+
+The writing functionality in Segyio is largely meant to *modify* or adapt
+files. A file created from scratch is not necessarily a to-spec SEG-Y file, as
+we only necessarily write the header fields segyio needs to make sense of the
+geometry. It is still highly recommended that SEG-Y files are maintained and
+written according to specification, but segyio does not mandate this.
+
 ## Getting started ##
 
 When Segyio is built and installed, you're ready to start programming! For

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/segyio.git