From ea95bca84b273460d35a8393dd488aec8cd38435 Mon Sep 17 00:00:00 2001
From: Ivan Pozdnyakov <Vanya.Pozdnyakov@charter.net>
Date: Thu, 21 May 2015 12:13:34 -0400
Subject: [PATCH] readme and gitignore

---
 .gitignore   |  1 +
 carCounter.h | 10 ++++-----
 readme.txt   | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 65 insertions(+), 5 deletions(-)
 create mode 100644 readme.txt

diff --git a/.gitignore b/.gitignore
index 8b0bc69..49973df 100644
--- a/.gitignore
+++ b/.gitignore
@@ -39,6 +39,7 @@
 
 # Python Files
 *.py
+*.i
 
 # sqlite DB files
 *.db
\ No newline at end of file
diff --git a/carCounter.h b/carCounter.h
index 92b77a3..d94467c 100644
--- a/carCounter.h
+++ b/carCounter.h
@@ -48,16 +48,16 @@
 #include "FrameDifferenceBGS.h"
 
 /* Frame datatype */
-/* Holistic reperesentation of all the objects captured in the given frame. */ 
+/* Holistic representation of all the objects captured in the given frame. */ 
 struct Frame
 {
-	// Geometric describition
+	// Geometric description
 	cv::vector<cv::vector<cv::Point>> contour;
 	cv::vector<cv::Rect> boundRect;
 	cv::vector<cv::Point2f> center;
 	cv::vector<float> radius;
 	
-	// Instanious metrics (based on current frame and the last)  
+	// Instantaneous metrics (based on current frame and the last)  
 	cv::vector<double> velocity;
 	cv::vector<double> velocityX;
 	cv::vector<double> velocityY;
@@ -83,7 +83,7 @@ struct Frame
 };
 
 /* Object datatype */
-/* Repersentation of all objects captured in the footage. */
+/* Representation of object. */
 struct Object
 {	
 	// Target data
@@ -357,7 +357,7 @@ class carCounter{
 	 *  startRegion:		 Set points for start Region.
 	 *  endRegion:			 Set points for end Region.
 	   
-	   Other parameters are settings for displaying if online mode is choosen.
+	   Other parameters are settings for displaying if online mode is chosen.
 	 */
 	void run(int bufferSize, int minObjectSizeDay, int minObjectSizeNight, int skip, int learningTime, 
 		char fileName[100], char saveImgTo[200], char dataBase[200], 
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..ec26462
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,59 @@
+How to use:
+
+Step 1:
+
+The following API requires openCV. Follow the instructions provided on openCV will guide you through the installation on
+windows.
+
+http://docs.opencv.org/doc/tutorials/introduction/windows_install/windows_install.html#windows-installation
+
+Step 2:
+
+Once installed you can start a new Visual Studio Project. Create the necessary property files and use them to link the library.
+
+http://docs.opencv.org/doc/tutorials/introduction/windows_visual_studio_Opencv/windows_visual_studio_Opencv.html#windows-visual-studio-how-to
+
+Step 3:
+
+Once the project is created you need to copy the following source and header files into your project folder & project explorer to
+compile and run the demo application.
+
+Note: Files marked with (*) are the required files if you want to use the API without the demo application.
+
+Source
+------------------------
+AdaptiveMedianBGS.cpp (*)
+DPAdaptiveMedianBGS.cpp (*)
+FrameDifferenceBGS.cpp (*)
+Image.cpp (*)
+
+sqlite3.c (*)
+
+main.cpp
+proxy.cpp
+runWrapper.cpp
+carCounter.cpp (*)
+
+Header
+------------------------
+AdaptiveMedianBGS.h (*)
+DPAdaptiveMedianBGS.h (*)
+FrameDifferenceBGS.h (*)
+Image.h (*)
+
+sqlite3.h (*)
+
+main.h
+proxy.h 
+runWrapper.h
+carCounter.h (*)
+
+Bgs.h (*)
+BgsParams.h (*)
+IBGS.h (*)
+
+Extras 
+(Put in the project folder)
+------------------------
+DPAdaptiveMedianBGS.xml
+FrameDifferenceBGS.xml
\ No newline at end of file