Update README.md

Krzysztow · Jul 16, 2013 · 959e8a6 · 959e8a6
1 parent b12ebeb
commit 959e8a6
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,32 @@ modbus-utils
 ============
 
 Modbus client and server command line tools based on libmodbus.
+
+NOTE:
+Both apps are linked with libmodbus library. After repository is pulled do the following:
+
+compilation
+===========
+#assumes you are in a root of the repository
+#go to libmodbus dir and compile it
+cd ./libmodbus
+./configure
+./make
+#as a result *.so libraries are in export ./src/.libs/ directory
+
+#get back to the root
+cd ..
+gcc ./modbus_client/modbus_client.c -I./common -I./libmodbus/src/ -L./libmodbus/src/.libs/ -lmodbus -o mbClient
+gcc ./modbus_server/modbus_server.c -I./common -I./libmodbus/src/ -L./libmodbus/src/.libs/ -lmodbus -o mbServer
+
+running
+=======
+If modbus libraries are not in a default location (either it's needed to move libraries to app location or set
+appropriate environment variable):
+- on linux it would be:
+  1) LD_LIBRARY_PATH=./libmodbus/src/.libs/ ./mbClient OR
+  2) export LD_LIBRARY_PATH=./libmodbus/src/.libs/ and then run ./mbClient
+
+usage
+=====
+Run apps with no arguments, descriptive help information will be provided.