Permalink
Browse files

Add a bunch of notes to the README

  • Loading branch information...
1 parent 6aca006 commit bc0b093786c04c7c270936e6d85ec033e3d4d971 @ferrous26 committed Feb 16, 2011
Showing with 23 additions and 0 deletions.
  1. +23 −0 README.markdown
View
@@ -4,6 +4,29 @@ rubygems-compile
A post-install hook for `macgem` to automatically compile rubygems
when you install them.
+All you need to do is:
+
+ gem install rubygems-compile
+
+And then you're off to the races! When you install gems you should get
+a bunch of output about files being compiled.
+
+Caveats
+=======
+
+* Large gems will take a long time to compile
+* This has only been tested on a few gems
+* Some gems specifically require a file with the extension defeating
+ the purpose of having a compiled version of the file
+
+TODO
+====
+
+- make the compilation an install option
+- add an option to replace the original file with the compiled version
+ + I can't remove the original and leave *.rbo files because of how
+ rubygems identifies gems unless I modify gemspec files
+
Contributing to rubygems-compile
=======================

0 comments on commit bc0b093

Please sign in to comment.