diff --git a/README b/README deleted file mode 100644 index 1bbb80178ea6b7064c70fa8c9d5b0d93eefc7a3f..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,26 +0,0 @@ -NLopt is a library for nonlinear local and global optimization, for -functions with and without gradient information. It is designed as -as simple, unified interface and packaging of several free/open-source -nonlinear optimization libraries. - -The latest version and a complete manual may be found at the NLopt -home page: - - http://ab-initio.mit.edu/nlopt - -It is compiled and installed with the standard GNU autoconf/automake -commands: - ./configure - make - make install -(See './configure --help' or the INSTALL file for other options.) - -Once it is installed, #include in your C/C++ programs and -link it with -lnlopt -lm. You may need to use the C++ compiler to link -in order to include the C++ libraries (which are used internally by NLopt, -even though it has a C API). - -The minimization function, nlopt_minimize, is described in the man -page (api/nlopt_minimize.3, which is installed by 'make install'. - -Interfaces for other languages may be added in the future. diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f00866bf615c2a49954b1b19304b60a08f5d43fd --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +NLopt is a library for nonlinear local and global optimization, for +functions with and without gradient information. It is designed as +as simple, unified interface and packaging of several free/open-source +nonlinear optimization libraries. + +The latest version and a complete manual may be found at the NLopt +home page: http://ab-initio.mit.edu/nlopt + +It is compiled and installed with the standard GNU autoconf/automake +commands: + + ./configure + make + make install + +(See `./configure --help` or the `INSTALL` file for other options.) + +Once it is installed, `#include ` in your C/C++ programs and +link it with `-lnlopt -lm`. You may need to use the C++ compiler to link +in order to include the C++ libraries (which are used internally by NLopt, +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`. + +There are also interfaces for Fortran, Python, Matlab, Octave, OCaml, +GNU Guile, GNU R, Lua, and Julia. Interfaces for other languages may +be added in the future.