beroe avatar beroe committed 1ddb6ab

Added installation instructions to the README

Comments (0)

Files changed (1)

database/README.md

 
 >All software is provided with the provision that the user will assume risks of its operation. Bugs exist! Use with care and use with files that have been backed up.
 
-File descriptions:
+# *File descriptions:
 
 * **VARSReplacementDictionary.py**
 * **flickr_search2.py**
 	- search flickr for images with certain tags and in certain bounding boxes
 * **flickrapi2.py**
 * **vars_image_move.py** 
-	- takes images retrieved by VARS query amd reorganizes them into folders
+	- takes images retrieved by VARS query and reorganizes them into folders
 * **vars_retrieve_concept.py**
  	- search MBARI database for dive summaries, samples, and annotations
 * **varscleanup.py**
  	- for cleaning up concept lists downloaded from VARS
 
 
+# *Notes on installation
+
+To use `vars_retrieve_concept.py` under OSX, you need to install the MySQL python tools with the following packages (in order):
+
+ * Get the **Command Line Tools** from https://developer.apple.com/downloads/ 
+ * Install HomeBrew by pasting this command in a Terminal window: 
+ *     `ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"`
+ * Install pip with this exact command:
+ *     `sudo easy_install pip`
+ * `brew install unixodbc`
+ * `brew install --with-unixodbc freetds`
+ * `sudo pip install pymssql` 
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.