From ddcdaa39b412c1b52e86d172145c5e19b25bc56b Mon Sep 17 00:00:00 2001
From: Tzafrir Cohen <tzafrir@cohens.org.il>
Date: Sun, 25 Sep 2016 20:48:44 +0300
Subject: Add a README

---
 README | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..3060c3a
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+MARC parser
+
+This code is intended to parse code in the MARC format[1] from the
+Israeli National Library.
+
+An example minimal file is included in the repository. A more complete
+data set could be downloaded from
+https://www.wetransfer.com/downloads/5ae37fc7985ddd1966b8c397cd2133a820160918061533/408158
+
+The code is Python 3. You can run a test with:
+
+  PYTHONPATH=$PWD python3 readers/xml_reader.py
+  PYTHONPATH=$PWD python3 testers/factorytester.py
+
+TODO: it seems to require adding the top-level directory to the
+PYTHONPATH.
+
+[1] http://www.loc.gov/marc/bibliographic/
+
-- 
cgit v1.2.3