chiark / gitweb /
clarify how to build from git
authorSteven G. Johnson <stevenj@alum.mit.edu>
Wed, 28 Aug 2013 14:17:33 +0000 (10:17 -0400)
committerSteven G. Johnson <stevenj@alum.mit.edu>
Wed, 28 Aug 2013 14:17:33 +0000 (10:17 -0400)
README.md

index 3bf79c9d487456b4f1ef2edfeea1ef0a9b060ad1..922be16d26c75e00093e85d8e2267ec630fb26c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,11 +9,20 @@ home page: http://ab-initio.mit.edu/nlopt
 It is compiled and installed with the standard GNU autoconf/automake
 commands:
 
-       ./configure
-       make
-       make install
+    ./configure
+    make
+    make install
 
-(See `./configure --help` or the `INSTALL` file for other options.)
+See `./configure --help` or the `INSTALL` file for other options.  To
+build the latest development sources:
+
+    git clone git://github.com/stevengj/nlopt
+    cd nlopt
+    sh autogen.sh
+    make
+
+(To build from git, you will need GNU autoconf, automake, and libtool
+installed, along with SWIG and Unix tools such as m4, perl, and sed.)
 
 Once it is installed, `#include <nlopt.h>` in your C/C++ programs and
 link it with `-lnlopt -lm`.  You may need to use the C++ compiler to link
@@ -22,7 +31,8 @@ even though it has a C API).
 
 The minimization function, `nlopt_minimize`, is described in the [man
 page](http://en.wikipedia.org/wiki/Man_page) (`api/nlopt_minimize.3`,
-which is installed by `make install`.
+which is installed by `make install`.  See also the manual on our
+web page.
 
 There are also interfaces for Fortran, Python, Matlab, Octave, OCaml,
 GNU Guile, GNU R, Lua, and Julia.  Interfaces for other languages may