diff --git a/Manifest.txt b/Manifest.txt index 1bff2932..3393724e 100644 --- a/Manifest.txt +++ b/Manifest.txt @@ -1,6 +1,6 @@ History.txt Manifest.txt -README.rdoc +README.md Rakefile bin/ocra share/ocra/lzma.exe diff --git a/README.rdoc b/README.md similarity index 77% rename from README.rdoc rename to README.md index a91f9bc2..8e2d839f 100644 --- a/README.rdoc +++ b/README.md @@ -1,23 +1,25 @@ -= ocra +# ocra -* https://github.com/larsch/ocra/ -* Issue tracker: http://github.com/larsch/ocra/issues -* Google Group: http://groups.google.com/group/ruby-ocra +home :: https://github.com/larsch/ocra/ -== DESCRIPTION: +issues :: http://github.com/larsch/ocra/issues + +forum :: http://groups.google.com/group/ruby-ocra + +## Description OCRA (One-Click Ruby Application) builds Windows executables from Ruby source code. The executable is a self-extracting, self-running executable that contains the Ruby interpreter, your source code and any additionally needed ruby libraries or DLL. -== FEATURES +## Features * LZMA Compression (optional, default on) * Both windowed/console mode supported * Includes gems based on usage, or from a Bundler Gemfile -== PROBLEMS & BUG REPORTING: +## Problems & Bug Reporiting * Windows support only @@ -26,11 +28,11 @@ the issue tracker on GitHub (http://github.com/larsch/ocra/issues). You can also join the Google Group discussion forum to ask questions and get help (http://groups.google.com/group/ruby-ocra). -== INSTALLATION: +## Installation Gem: - gem install ocra + gem install ocra Alternatively you can download the gem at either http://rubygems.org/gems/ocra or @@ -40,23 +42,23 @@ Stand-alone Version: Get ocrasa.rb from https://github.com/larsch/ocra/releases/. Requires nothing but a working Ruby installation on Windows. -== SYNOPSIS: +## Synopsis -=== Building an executable: +### Building an executable: - ocra script.rb + ocra script.rb -Will package "script.rb", the Ruby interpreter and all +Will package `script.rb`, the Ruby interpreter and all dependencies (gems and DLLs) into an executable named -"script.exe". +`script.exe`. -=== Command line: +### Command line: - ocra [options] script.rb [ ...] [--