README in mkmf-lite-0.1.0 vs README in mkmf-lite-0.2.0
- old
+ new
@@ -1,9 +1,15 @@
-= Summary
+== Summary
A light version of mkmf designed for use within programs.
-= Synopsis
+== Installation
+ gem install mkmf-lite
+
+== Prerequisites
+ A C compiler somewhere on your system.
+
+== Synopsis
require 'mkmf/lite'
class System
include Mkmf::Lite
@@ -14,23 +20,31 @@
# Do something
end
end
end
-= Description
+== Description
The mkmf library that ships as part of the Ruby standard library is not
meant for use as an internal library. It's strictly designed for building
C extensions. It's huge, its methods sit in a global namespace, it contains
- many methods you don't care about, and emits output to $stdout that cannot
+ many methods you don't care about, and it emits stuff to $stdout that cannot
easily be disabled. Also, the source code is monstrous.
- The mkmf-lite is a module, it's small, and it's designed to be mixed into
- classes. It contains a handful of methods that, most likely, will be used
- in conjunction with FFI. Also, the source code is quite readable.
+ The mkmf-lite library is a module, it's small, and it's designed to be mixed
+ into classes. It contains a handful of methods that, most likely, will be
+ used in conjunction with FFI. Also, the source code is quite readable.
- It does not package C extensions, nor generate a log file or a Makefile.
+ It does not package C extensions, nor generate a log file or a Makefile. It
+ does, however, require that you have a C compiler somewhere on your system.
+== Known Issues
+ You may see this warning from JRuby 1.4.x and earlier:
+
+ warning: Useless use of a variable in void context.
+
+ You can ignore these (or, upgrade your Jruby).
+
== License
Artistic 2.0
== Copyright
(C) 2010 Daniel J. Berger
@@ -39,7 +53,7 @@
== Warranty
This library is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantability and fitness for a particular purpose.
-= Author
+== Author
Daniel Berger