Permalink
Browse files

Made README clearer.

  • Loading branch information...
1 parent fd63acf commit 8e70cf4803e18efb23d12f528d5f53bc777e4ae7 @pankajgupta committed Jan 25, 2012
Showing with 8 additions and 2 deletions.
  1. +8 −2 README
View
10 README
@@ -1,5 +1,11 @@
Reads each line from stdin, where each line is of one or two formats:
-1. <ignore> <value>
+1. <to-be-ignored> <value>
2. <value> <freq>
-This script outputs the distributions and various statistics of a group of such lines, on stdout as a comma separated set of lines. it has been tested to work on hundreds of millions of lines (which at the time of this writing take a few minutes on my computer).
+This script outputs the distributions and various statistics of a group of such lines, on stdout as a comma separated set of lines. it has been tested to work on hundreds of millions of lines (which at the time of this writing take a few minutes on my laptop).
+
+Example invocation:
+
+#input.txt: a file containing values of type 1 above where the first column is ignored. We use the '-v'
+#option for that format. Also, if you want the separator to be tab, on shell type Ctrl-v followed by <tab> key.
+distribution.rb -v -t' ' -p percentiles.txt < out_edges.txt

0 comments on commit 8e70cf4

Please sign in to comment.