diff --git a/README.rdoc b/README.md similarity index 70% rename from README.rdoc rename to README.md index 4d296da..4d1570b 100644 --- a/README.rdoc +++ b/README.md @@ -1,4 +1,4 @@ -== xtm-utils +# xtm-utils xtm-utils is a set of tools for joining or splitting files using the XTM format. @@ -6,22 +6,21 @@ format. It is an open-source replacement for the the closed-source binary provided by the XtremSplit website. -=== Licence +### Minimum requirements -xtm-utils is distributed under the GNU LGPL-3 licence. +* Ruby 1.8 +* bindata gem -=== Authors +### Usage + +```shell-session +$ gem install xtm-utils +``` + +## Authors Glenn Y. Rolland (glenux@glenux.net) -=== Download +## Licence -=== Minimum requirements - -* ruby 1.8 -* bindata gem - -=== Getting started - - - +xtm-utils is distributed under the GNU LGPL-3 licence.