[mlpack-git] master: Highlight some commands. (c41bc8d)

gitdub at big.cc.gt.atl.ga.us gitdub at big.cc.gt.atl.ga.us
Sun Apr 5 13:56:02 EDT 2015


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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/8540c1be5ef882b6c7cbdd267327e35746ff9efe...c41bc8d54695f1a20b3de551bc80fe7221dd3cd1

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

commit c41bc8d54695f1a20b3de551bc80fe7221dd3cd1
Author: Marcus Edel <marcus.edel at fu-berlin.de>
Date:   Sun Apr 5 19:55:58 2015 +0200

    Highlight some commands.


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

c41bc8d54695f1a20b3de551bc80fe7221dd3cd1
 README.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index bf73856..4522a6c 100644
--- a/README.md
+++ b/README.md
@@ -141,7 +141,7 @@ write permissions to those three directories), and simply type
 You can now run the executables by name; you can link against mlpack with
     `-lmlpack`
 and the mlpack headers are found in
-    `/usr/local/include/mlpack/.
+    `/usr/local/include/mlpack/`.
 
 If running the programs (i.e. `$ allknn -h`) gives an error of the form
 
@@ -160,7 +160,7 @@ manually).  One way to do this, on Linux, is to ensure that the
 5. Running mlpack programs
 --------------------------
 
-After building mlpack, the executables will reside in `build/bin/.  You can call
+After building mlpack, the executables will reside in `build/bin/`.  You can call
 them from there, or you can install the library and (depending on system
 settings) they should be added to your PATH and you can call them directly.  The
 documentation below assumes the executables are in your PATH.
@@ -185,7 +185,7 @@ same) and finding the 5 nearest neighbors is very simple:
 
     $ allknn -r dataset.csv -n neighbors_out.csv -d distances_out.csv -k 5 -v
 
-The -v (--verbose) flag is optional; it gives informational output.  It is not
+The `-v (--verbose)` flag is optional; it gives informational output.  It is not
 unique to allknn but is available in all mlpack programs.  Verbose output also
 gives timing output at the end of the program, which can be very useful.
 
@@ -193,7 +193,7 @@ gives timing output at the end of the program, which can be very useful.
 ------------------------
 
 The documentation given here is only a fraction of the available documentation
-for mlpack.  If doxygen is installed, you can type 'make doc' to build the
+for mlpack.  If doxygen is installed, you can type `make doc` to build the
 documentation locally.  Alternately, up-to-date documentation is available for
 older versions of mlpack:
 



More information about the mlpack-git mailing list