From ce764a04b63de5c47c4afc29b31a67875019d4be Mon Sep 17 00:00:00 2001 From: Sam Popowich Date: Tue, 29 Jul 2014 15:34:40 -0600 Subject: [PATCH] Replace default README I replaced the default README.rdoc with a stub README.md which contains actual information regarding the discovery project. --- README.md | 8 ++++++++ README.rdoc | 28 ---------------------------- 2 files changed, 8 insertions(+), 28 deletions(-) create mode 100644 README.md delete mode 100755 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 000000000..b9fbee0e0 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +Discovery Interface for University of Alberta Libraries +======================================================= + +This is the code base for the University of Alberta Libraries's +discovery platform. Based on [Project +Blacklight](projectblacklight.org), it uses Ansible for configuration +management, Solr for the search index, Nginx as a proxy server, and +Unicorn as the web server. diff --git a/README.rdoc b/README.rdoc deleted file mode 100755 index dd4e97e22..000000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app.