add explanation about path to doc

umontreal-simul · Aug 14, 2018 · a6b6aa5 · a6b6aa5
1 parent d49515e
commit a6b6aa5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/doc/dox/libtut.dox b/doc/dox/libtut.dox
@@ -31,6 +31,17 @@ This tutorial is divided in three parts:
 - \subpage libtut_lat
 - \subpage libtut_net
 - \subpage libtut_impl
-*/
 
+
+To use the library, you must include the \link netbuilder/Path.h \endlink file in your program and use the appropriate
+function to set the path to the directory containing the `latnetbuilder` executable. 
+For instance, if the `latnetbuilder` command is in the PATH environment variable and you are on a Unix-system, use
+\verbatim
+#include "netbuilder/Path.h"
+NetBuilder::FIND_PATH_TO_LATNETBUILDER_DIR();
+\endverbatim
+Other functions can be used to directly set an absolute path to the directory containing the `latnetbuilder`
+executable such as NetBuilder::SET_PATH_TO_LATNETBUILDER_DIR.
+
+*/
 vim: ft=doxygen spelllang=en spell
diff --git a/wscript b/wscript
@@ -51,12 +51,12 @@ def configure(ctx):
     ctx_check(features='cxx cxxprogram',
             lib='boost_system',
             uselib_store='SYSTEM')
-    ctx_check(features='cxx cxxprogram',
-            header_name='boost/filesystem.hpp',
-            lib='boost_system')
     ctx_check(features='cxx cxxprogram',
             lib='boost_filesystem',
             uselib_store='FILESYSTEM')
+    #ctx_check(features='cxx cxxprogram',
+    #        header_name='boost/filesystem.hpp',
+    #        lib=['boost_system', 'boost_filesystem'])
 
     # Boost Chrono
     # ctx_check(features='cxx cxxprogram',