README.rdoc in snp-search-0.1.0 vs README.rdoc in snp-search-0.2.0
- old
+ new
@@ -1,17 +1,37 @@
= snp-search
-Description goes here.
+snp-search is a set of tools that manages SNP data and allows for data importing, manipulating, editing and complex querying of SNP data. It can be used to evaluate the utility of SNPs for the assessment of genetic diversity between strains and the management of genotype and phenotype data. Once a query is performed, SNPsearch can be used to convert the selected SNP data into FASTA sequences. SNPsearch is particularly useful in the analysis of phylogenetic trees that are based on SNP differences across whole core genomes. Queries can be made to answer critical genomic questions such as the association of SNPs with particular phenotypes.
+== Obtaining and installing the code
+snp-search is written in Ruby and operates in a Unix enviroment. It is made available as a gem. See the github site for more information (https://github.com/hpa-bioinformatics/snp-search).
+
+To install snp-search, do
+ gem install snp-search
+
+== Requirements
+
+* ActiveRecord: The snp-search API is based on ActiveRecord to get the data from the database. ActiveRecord is available as a gem:
+ gem install activerecord
+
+* SQLite3: The SQL engine used is sqlite3. Most Linux operating systems come with sqlite3. However if you do not have sqlite then you may download it from http://www.sqlite.org/download.html. The installation instructions are available in the download page.
+
+* bio gem.
+
+== Running snp-search
+
+Step 1:
+
== Contributing to snp-search
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+*
== Copyright
Copyright (c) 2011 Ali Al-Shahib. See LICENSE.txt for
further details.