Add developer guide and api doc

README.md

@@ -19,7 +19,7 @@ Getting started
 ===============
 
 Ecl output files consist of a sequence of named arrays. ecl-data-io does not
-interpret the names, but simply give you a touple of the name and a numpy array
+interpret the names, but simply give you a tuple of the name and a numpy array
 with the read function:
 
 ```

docs/source/api_doc.rst

@@ -0,0 +1,12 @@
+API-Doc
+=======
+
+.. autofunction:: ecl_data_io.lazy_read
+
+.. autofunction:: ecl_data_io.read
+
+.. autofunction:: ecl_data_io.write
+
+.. autoclass:: ecl_data_io.Format
+
+.. autoclass:: ecl_data_io.MESS

docs/source/developer_guide.rst

@@ -0,0 +1,26 @@
+Building from source and running the tests
+==========================================
+
+ecl-data-io is set up to use tox which can simplify development,
+but all that is necessary in order to get started is git, pip and python:
+
+First, install ecl-data-io in editable mode:
+
+.. code-block:: console
+
+git clone [email protected]:equinor/ecl-data-io.git
+cd ecl-data-io
+pip install -e .
+
+Second, install the dev-requirements.txt, which contains the packages ecl-data-io
+require in order to run tests:
+
+.. code-block:: console
+
+pip install -r dev-requirements.txt
+
+At last, you can use pytest to run the tests
+
+.. code-block:: console
+
+pytest tests

docs/source/example_usage.rst

@@ -9,7 +9,7 @@ and :meth:`ecl_data_io.write` functions:
 read
 ----
 
-The read function will open a given file and give you a list of touples
+The read function will open a given file and give you a list of tuples
 of the keywords and arrays.
 
 >>> import ecl_data_io as eclio