Permalink
Browse files

Add installation instructions

  • Loading branch information...
1 parent e8f544d commit d0285cf2ac9c0e093a7e367774fec25da1207c97 @b4winckler committed Jun 19, 2012
Showing with 23 additions and 2 deletions.
  1. +23 −2 README.markdown
View
@@ -1,4 +1,4 @@
-This is a command line tool that can compute the up-down signature
+This is a command line tool that can compute up-down signature
probabilities. For more information on up-down signatures see the
[up-down-signature](https://github.com/b4winckler/up-down-signature) library.
@@ -8,5 +8,26 @@ of integers. Subsequent lines are intepreted as lists of doubles. Each line
must have the same number of entries as the first line. The up-down signature
(cumulative) probability is calculated for each line and printed on `stdout`.
+
+## Usage in R
+
See the `sigscore()` function in the [bapp](https://github.com/b4winckler/bapp)
-library on how to call this tool from within R.
+library on how to call this tool from within R. Also see the
+[examples](https://github.com/b4winckler/sigscore/tree/master/examples)
+directory.
+
+
+## Installation
+
+[Download](https://github.com/b4winckler/sigscore/downloads) a binary version
+and put it somewhere in your path.
+
+Alternatively, clone this repository and build it with `cabal`:
+
+ $ git clone https://github.com/b4winckler/sigscore.git
+ $ cd sigscore
+ $ cabal install
+
+Note that this requires that you have installed a Haskell compiler and `cabal`,
+both of which are included in the
+[Haskell platform](http://hackage.haskell.org/platform/).

0 comments on commit d0285cf

Please sign in to comment.