Commits

Chad Perrin committed ce01978

README is Markdown formatted

  • Participants
  • Parent commits 5746eca

Comments (0)

Files changed (2)

README

-# CmpText
-
-CmpText is a simple text comparison tool.  It was originally created for the
-purpose of comparing two copyright licenses to determine their textual
-similarity.  At present, its only use is to compare two texts and return a
-percentage match score.
-
-## Usage
-
-Include the CmpText module in a class:
-
-    require 'cmp_text'
-    
-    class Foo
-      include CmpText
-      # more code here
-    end
-
-Use the `cmp_text.rb` file directly as a command line utility:
-
-    $ cmp_text.rb file1.txt file2.txt
-
-## Roadmap
-
-Plans for this project include turning it into a Ruby gem and creating an
-online license comparison page at the [Copyfree Initiative][0] site.
-
-## License
-
-Copyright 2011 Sterling Camden
-
-The `cmp_text.rb` file may be distributed under the terms of the Open Works
-License.  See the `license.txt` file for details.
-
-[0]: http://copyfree.org
+# CmpText
+
+CmpText is a simple text comparison tool.  It was originally created for the
+purpose of comparing two copyright licenses to determine their textual
+similarity.  At present, its only use is to compare two texts and return a
+percentage match score.
+
+## Usage
+
+Include the CmpText module in a class:
+
+    require 'cmp_text'
+    
+    class Foo
+      include CmpText
+      # more code here
+    end
+
+Use the `cmp_text.rb` file directly as a command line utility:
+
+    $ cmp_text.rb file1.txt file2.txt
+
+## Roadmap
+
+Plans for this project include turning it into a Ruby gem and creating an
+online license comparison page at the [Copyfree Initiative][0] site.
+
+## License
+
+Copyright 2011 Sterling Camden
+
+The `cmp_text.rb` file may be distributed under the terms of the Open Works
+License.  See the `license.txt` file for details.
+
+[0]: http://copyfree.org