From 55dd69721df98051eb8789e1416d9d15769ee4ff Mon Sep 17 00:00:00 2001
From: Alex Yatskov <alex@foosoft.net>
Date: Sun, 22 Mar 2015 16:56:57 +0900
Subject: [PATCH] Adding readme

---
 README.md                       | 40 +++++++++++++++++++++++++++++++++
 {scrape => db}/build_db.js      |  0
 {scrape => db}/cache/.gitignore |  0
 {scrape => db}/cache/geo.json   |  0
 {scrape => db}/data.json        |  0
 {scrape => db}/dump.sh          |  0
 {scrape => db}/geocode.js       |  0
 {scrape => db}/hscd.sql         |  0
 {scrape => db}/init.sh          |  0
 {scrape => db}/init.sql         |  0
 {scrape => db}/load.sh          |  0
 {scrape => db}/package.json     |  0
 {scrape => db}/scrape.js        |  0
 {scrape => db}/stations.json    |  0
 14 files changed, 40 insertions(+)
 create mode 100644 README.md
 rename {scrape => db}/build_db.js (100%)
 rename {scrape => db}/cache/.gitignore (100%)
 rename {scrape => db}/cache/geo.json (100%)
 rename {scrape => db}/data.json (100%)
 rename {scrape => db}/dump.sh (100%)
 rename {scrape => db}/geocode.js (100%)
 rename {scrape => db}/hscd.sql (100%)
 rename {scrape => db}/init.sh (100%)
 rename {scrape => db}/init.sql (100%)
 rename {scrape => db}/load.sh (100%)
 rename {scrape => db}/package.json (100%)
 rename {scrape => db}/scrape.js (100%)
 rename {scrape => db}/stations.json (100%)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f35436
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Reactive Search Prototype
+
+
+## Introduction
+
+This installation guide is designed for Linux distributions based on Ubuntu. It should be trivial to get this
+application running on other Linux flavors, but you may have to install different packages to satisfy the dependencies.
+
+
+## System Dependencies
+
+Execute the command `apt-get install package_name` to install these packages (must be root).
+
+*   `mysql-server`
+*   `nodejs`
+*   `nodejs-legacy`
+*   `npm`
+
+
+## Global Node.js Dependencies
+
+Execute the command `npm install -g package_name` to install these packages (must be root).
+
+*   `gulp`
+*   `bower`
+
+
+## Database Initialization
+
+1.  Execute `./db/init.sh` to create the required database and associated user. You will be prompted for the mysql root
+    password; if you do not have one configured you may continue by inputting an empty string.
+2.  Load the initial data tables by running `./db/load.sh`. You may perform this step again at a later time if you wish
+    to reset the contents of the database to their original state.
+
+
+## Client and Server Initialization
+
+1.  From the application base directory execute the command `npm install`.
+2.  While in the same directory execute the command `gulp install`.
+3.  Execute the command `gulp` to start the application HTTP server on port 3000.
diff --git a/scrape/build_db.js b/db/build_db.js
similarity index 100%
rename from scrape/build_db.js
rename to db/build_db.js
diff --git a/scrape/cache/.gitignore b/db/cache/.gitignore
similarity index 100%
rename from scrape/cache/.gitignore
rename to db/cache/.gitignore
diff --git a/scrape/cache/geo.json b/db/cache/geo.json
similarity index 100%
rename from scrape/cache/geo.json
rename to db/cache/geo.json
diff --git a/scrape/data.json b/db/data.json
similarity index 100%
rename from scrape/data.json
rename to db/data.json
diff --git a/scrape/dump.sh b/db/dump.sh
similarity index 100%
rename from scrape/dump.sh
rename to db/dump.sh
diff --git a/scrape/geocode.js b/db/geocode.js
similarity index 100%
rename from scrape/geocode.js
rename to db/geocode.js
diff --git a/scrape/hscd.sql b/db/hscd.sql
similarity index 100%
rename from scrape/hscd.sql
rename to db/hscd.sql
diff --git a/scrape/init.sh b/db/init.sh
similarity index 100%
rename from scrape/init.sh
rename to db/init.sh
diff --git a/scrape/init.sql b/db/init.sql
similarity index 100%
rename from scrape/init.sql
rename to db/init.sql
diff --git a/scrape/load.sh b/db/load.sh
similarity index 100%
rename from scrape/load.sh
rename to db/load.sh
diff --git a/scrape/package.json b/db/package.json
similarity index 100%
rename from scrape/package.json
rename to db/package.json
diff --git a/scrape/scrape.js b/db/scrape.js
similarity index 100%
rename from scrape/scrape.js
rename to db/scrape.js
diff --git a/scrape/stations.json b/db/stations.json
similarity index 100%
rename from scrape/stations.json
rename to db/stations.json