Update readme.md & rename library files

4 files changed, 48 insertions, 5 deletions

diff --git a/README.md b/README.md
index 88b0006..1b2e53a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,39 @@
 SimpleMotionV2
 ==============
 
-SimpleMotion V2 library
+This is a SimpleMotion V2 library, which is an API to control motor controller from any programmable platform, such as PC, PLC or MCU.
 
-For more information, see:
+For main documentation, see:
 http://granitedevices.com/wiki/SimpleMotion_V2
+
+
+Files & usage
+=============
+
+There are files that are needed for basic SimpleMotion usage, and files that are optional and needed only for certain features. Following may be useful info when porting library to different platforms (such as embedded MCU) to avoid unnecessary work on some files.
+
+Compulsory
+----------
+
+- simplemotion.c/.h
+- sm485.h
+- sm_consts.c
+- simplemotion_defs.h
+- simplemotion_private.h
+- busdevice.c/.h
+
+Platform specific
+-----------------
+Following files probably need modification if ported to another platform
+
+- pcserialport.c/.h - Contains a driver for communication device interface. This driver controls serial/COM port on Unix & Windows. Also busdevice.c/.h need to be modified accordingly if this driver is removed or modified.
+
+A typical platform port would involve writing a communication driver that implements same functions as pcserialport.c and adding their relevant calls to busdevice.c/.h.
+
+Feature specific
+----------------
+
+- bufferedmotion.c/.h - Library used for buffered motion stream applications
+- devicedeployment.c/.h - Library used for installing firmware and loading settings into target devices. Can be used to configure devices automatically in-system.
+
+For practical usage examples, refer to https://github.com/GraniteDevices/SimpleMotionV2Examples
\ No newline at end of file
diff --git a/SimpleMotionV2.pri b/SimpleMotionV2.pri
index 7254e17..9d2caf5 100644
--- a/SimpleMotionV2.pri
+++ b/SimpleMotionV2.pri
@@ -6,9 +6,9 @@ DEPENDPATH += $$PWD
 DEFINES += SIMPLEMOTIONV2_LIBRARY

 

 SOURCES += $$PWD/sm_consts.c $$PWD/simplemotion.c $$PWD/busdevice.c $$PWD/pcserialport.c \

-    $$PWD/bufferedmotion.c $$PWD/smdeploymenttool.c

+    $$PWD/bufferedmotion.c $$PWD/devicedeployment.c

 

 HEADERS += $$PWD/simplemotion_private.h\

     $$PWD/pcserialport.h $$PWD/busdevice.h  $$PWD/simplemotion.h $$PWD/sm485.h $$PWD/simplemotion_defs.h \

-    $$PWD/bufferedmotion.h $$PWD/smdeploymenttool.h

+    $$PWD/bufferedmotion.h $$PWD/devicedeployment.h

 

diff --git a/smdeploymenttool.c b/devicedeployment.c
index 2551128..bdb718d 100644
--- a/smdeploymenttool.c
+++ b/devicedeployment.c
@@ -1,4 +1,4 @@
-#include "smdeploymenttool.h"
+#include "devicedeployment.h"
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
diff --git a/smdeploymenttool.h b/devicedeployment.h
index 8838664..f6fa08e 100644
--- a/smdeploymenttool.h
+++ b/devicedeployment.h
@@ -1,3 +1,14 @@
+/* Device deployment library based on SimpleMotionV2 lib. Features:
+ *
+ * - install .gdf format firmware to drive
+ * - load .drc settings file to drive
+ * - read installed firmware binary checksum from device - this may be used to verify that exact correct FW build is installed in the drive
+ *
+ * TODO:
+ * - Support Argon. Currently tested only on IONI/ATOMI series drives. Currently FW upgrade on Argon will fail, but settings load may work.
+ * - Add some way of reading binary checksum from .gdf file or settings file. Now user must read it from device and store that number somewhere manually.
+ */
+
 #ifndef SMDEPLOYMENTTOOL_H
 #define SMDEPLOYMENTTOOL_H