summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndreas Maunz <andreas@maunz.de>2012-03-29 10:43:26 +0200
committerAndreas Maunz <andreas@maunz.de>2012-03-29 10:43:26 +0200
commita0d99ccf4d2120dff26b2625a4bc1f5eca350f2b (patch)
tree1739cc22344450bcd9bafc298b709cf538f6c047 /README.md
first commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a86dbc3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# openbabel gem
+
+GEM for [OpenBabel](http://openbabel.sf.net), a chemical library by Noel O'Boyle and others.
+
+openbabel gem has been tested with ruby 1.9. It only compiles on POSIX systems and requires:
+
+ * cmake
+ * curl
+ * tar, sed, make (those should be present anyway)
+
+## Install
+gem install openbabel
+
+It downloads the sources, compiles the ruby bindings and installs them. Check out [http://cs.maunz.de](http://cs.maunz.de) for more information.