[mlpack-git] master: Refactor notice about LD_LIBRARY_PATH. (402f7b8)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/a441349cbbd4e233337d2cbe87dfd66c89b41522...402f7b87c64cc9ca0e056cf174d7f47a4a4c9cb1

>---------------------------------------------------------------

commit 402f7b87c64cc9ca0e056cf174d7f47a4a4c9cb1
Author: Ryan Curtin <ryan at ratml.org>
Date:   Mon Feb 2 17:09:59 2015 -0500

    Refactor notice about LD_LIBRARY_PATH.


>---------------------------------------------------------------

402f7b87c64cc9ca0e056cf174d7f47a4a4c9cb1
 README.md | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 960a3c9..46beb41 100644
--- a/README.md
+++ b/README.md
@@ -138,22 +138,24 @@ permissions to those two directories), and simply type
 
     $ make install
 
-As an example to check if install is working fine,type
-
-    $ allknn --h
+You can now run the executables by name; you can link against mlpack with
+    -lmlpack
+and the mlpack headers are found in
+    /usr/include/mlpack/.
 
-to get the help for the k nearest neigbours implementation of mlpack.
+If running the programs (i.e. `$ allknn -h`) gives an error of the form
 
-If instead you get an error about problem of loading the .so files then add line 
+    error while loading shared libraries: libmlpack.so.1: cannot open shared object file: No such file or directory
 
-   export LD_LIBRARY_PATH=/usr/local/lib 
+then be sure that the runtime linker is searching the directory where
+`libmlpack.so` was installed (probably `/usr/local/lib/` unless you set it
+manually).  One way to do this, on Linux, is to ensure that the
+`LD_LIBRARY_PATH` environment variable has the directory that contains
+`libmlpack.so`.  Using bash, this can be set easily:
 
-to .bashrc file.
+    export LD_LIBRARY_PATH=/usr/local/lib/
 
-You can now run the executables by name; you can link against mlpack with
-    -lmlpack
-and the mlpack headers are found in
-    /usr/include/mlpack/.
+(or whatever directory `libmlpack.so` is installed in.)
 
 
 5. Running mlpack programs