From 60d5207d12cfc59929d7cc3bba2066f8aebd8515 Mon Sep 17 00:00:00 2001
From: Ed Summers <ehs@pobox.com>
Date: Fri, 12 Aug 2011 00:18:06 -0400
Subject: [PATCH] modified readme

---
 .gitignore |  1 +
 README.md  | 28 ++++++++++++++++++++++++++++
 README.txt | 13 -------------
 3 files changed, 29 insertions(+), 13 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 README.md
 delete mode 100644 README.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0d20b64
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc8b068
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+id is a django project for serving up LCSH authority data as SKOS RDF, JSON
+and HTML. Once upon a time it was the prototype code for the service running
+at id.loc.gov, but it has since been superseded. It is here in GitHub mainly 
+for historical reasons, and also to keep the MARC -> SKOS mapping, which could
+be useful for some purposes in the future.
+
+The paper [LCSH, SKOS and Linked Data](http://arxiv.org/abs/0805.2855) has some
+background information, on why this project was done.
+
+## Installation
+
+1. install python
+1. install mysql
+1. python setup.py build # should install python dependencies
+1. echo "CREATE DATABASE id CHARACTER SET utf8; GRANT ALL ON id.* to '{username}'@'localhost' identified by '{password}';" | mysql -u root -p
+
+1. update DATABASE_USER and DATABASE_PASSWORD in settings.py
+1. update MEDIA_ROOT in settings.py to be the full path to the static directory
+1. change AUTHORITIES_URL as appropriate in settings.py 
+1. python manage.py syncdb
+1. echo "ALTER table authorities_concept ADD FULLTEXT INDEX concept_fulltext_index (pref_label);" | mysql -u {username} -p id
+1. python manage.py load_marcxml marc.xml
+1. python manage.py runserver
+1. go to http://localhost:8000/authorities
+
+## License
+
+Public Domain <http://creativecommons.org/licenses/publicdomain/>
diff --git a/README.txt b/README.txt
deleted file mode 100644
index d93a930..0000000
--- a/README.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-01. install python
-02. install mysql
-03. python setup.py build # should install python dependencies
-04. echo "CREATE DATABASE id CHARACTER SET utf8; GRANT ALL ON id.* to '{username}'@'localhost' identified by '{password}';" | mysql -u root -p
-
-05. update DATABASE_USER and DATABASE_PASSWORD in settings.py
-06. update MEDIA_ROOT in settings.py to be the full path to the static directory
-07. change AUTHORITIES_URL as appropriate in settings.py 
-08. python manage.py syncdb
-09. echo "ALTER table authorities_concept ADD FULLTEXT INDEX concept_fulltext_index (pref_label);" | mysql -u {username} -p id
-10. python manage.py load_marcxml marc.xml
-11. python manage.py runserver
-12. go to http://localhost:8000/authorities