Skip to content

Commit 4067d4a

Browse files
committed
[README] Update introduction
1 parent d3a119b commit 4067d4a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,17 @@
55
.. image:: https://coveralls.io/repos/github/G-Node/python-odml/badge.svg?branch=master
66
:target: https://coveralls.io/github/G-Node/python-odml?branch=master
77

8-
odML libraries and editor
9-
=========================
8+
odML (Open metaData Markup Language) core library
9+
=================================================
10+
11+
The open metadata Markup Language is a file based format (XML, JSON, YAML) for storing
12+
metadata in an organised human- and machine-readable way. odML is an initiative to define
13+
and establish an open, flexible, and easy-to-use format to transport metadata.
14+
15+
The Python-odML library can be easily installed via :code:`pip`. The source code is freely
16+
available on `GitHub <https://github.com/G-Node/python-odml>`_. If you are not familiar
17+
with the version control system **git**, but still want to use it, have a look at the
18+
documentation available on the `git-scm website <https://git-scm.com/>`_.
1019

1120
Dependencies
1221
------------
@@ -74,4 +83,5 @@ Bugs & Questions
7483
Should you find a behaviour that is likely a bug, please file a bug report at
7584
`the github bug tracker <https://github.com/G-Node/python-odml/issues>`_.
7685

77-
If you have questions regarding the use of the library or the editor, feel free to join the `#gnode <http://webchat.freenode.net?channels=%23gnode>`_ IRC channel on freenode.
86+
If you have questions regarding the use of the library, feel free to join the
87+
`#gnode <http://webchat.freenode.net?channels=%23gnode>`_ IRC channel on freenode.

0 commit comments

Comments
 (0)