[doc] Add some basic information in README
authorSylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 01 Sep 2017 10:59:40 +0200
changeset 2670 a671735e9217
parent 2669 a88e6cc83189
child 2671 fcf239b4e613
[doc] Add some basic information in README
README
--- a/README	Thu Aug 31 16:03:55 2017 +0200
+++ b/README	Fri Sep 01 10:59:40 2017 +0200
@@ -1,3 +1,26 @@
 Summary
 -------
-Data Exchange Standard for Archival
+
+This cube implements the SEDA_ standard for CubicWeb. It has been funded by the
+SIAF_ and the `SAEM project`_.
+
+.. _SEDA: https://redirect.francearchives.fr/seda/
+.. _SIAF: https://fr.wikipedia.org/wiki/Service_interministériel_des_Archives_de_France
+.. _`SAEM project`: http://www.saem.e-bordeaux.org/
+
+Project is hosted at https://www.cubicweb.org/project/cubicweb-seda/ and source
+code at https://hg.logilab.org/master/cubes/seda.
+
+To launch the tests::
+
+  python -m tox
+
+To generate the documentation::
+
+  python -m tox -e doc
+
+Part of the code is generated from SEDA 2's XSD schema. If you update the schema
+or code generator (on of the `cubicweb_seda/xsd*.py` files), to update the
+generated code type::
+
+  python -m tox -e make