Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updating README

  • Loading branch information...
commit 5b0c89efc2c2b8198981566eca490afe32c440f5 1 parent a0fcb91
@tenderlove authored
Showing with 26 additions and 5 deletions.
  1. +16 −5 README.txt
  2. +1 −0  Rakefile
  3. +9 −0 bin/omfg
View
21 README.txt
@@ -1,22 +1,33 @@
= zomg
-* FIX (url)
+* http://zomg.rubyforge.org/
+* http://tenderlovemaking.com/
== DESCRIPTION:
-FIX (describe your package)
+ZOMG is an OMG IDL parser. ZOMG will generate a Ruby AST from an IDL AST,
+and will even generate ruby (by means of Ruby2Ruby).
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
+* Parses IDL, generates Ruby
+* Ships with OMFG the Object Management File Generator
+* Ignores nested structs/unions
+* Treats out/inout parameters are DIY
== SYNOPSIS:
- FIX (code sample of usage)
+In code:
+
+ ZOMG::IDL.parse(File.read(ARGV[0])).to_ruby
+
+Command line:
+
+ $ omfg awesome.idl
== REQUIREMENTS:
-* FIX (list of requirements)
+* ruby2ruby
== INSTALL:
View
1  Rakefile
@@ -13,6 +13,7 @@ require 'zomg/version'
Hoe.new('zomg', ZOMG::VERSION) do |p|
p.developer('Aaron Patterson', 'aaronp@rubyforge.org')
p.clean_globs = [GENERATED_LEXER, GENERATED_SCANNER]
+ p.description = p.paragraphs_of('README.txt', 3..10).join("\n\n")
p.extra_deps = ['ruby2ruby']
end
View
9 bin/omfg
@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'zomg'
+
+tree = ARGV[0] ?
+ ZOMG::IDL.parse(File.read(ARGV[0])) : ZOMG::IDL.parse($stdin.read)
+
+puts tree.to_ruby
Please sign in to comment.
Something went wrong with that request. Please try again.