Documentation updated

ConstantRobotics-Ltd · May 17, 2024 · 2d945fa · 2d945fa
1 parent b1b4a56
commit 2d945fa
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 
-![plot_opencv_logo](_static/plot_opencv_logo.png)
+![plot_opencv_logo](./static/plot_opencv_logo.png)
 
 
 
-# **plotOpenCv C++ library**
+# **PlotOpenCv C++ library**
 
-**v1.0.2**
+**v1.0.3**
 
 
 
@@ -27,7 +27,7 @@
 
 # Overview
 
-**plotOpenCv** is a C++ library developed to facilitate the visualization of 2-dimensional line charts. This library is built upon the OpenCV, providing users with a convenient and efficient tool for visualizing data through line charts. With plotOpenCv, users can effortlessly create multiple line charts within a single window and tune various chart parameters, such as line width, color, and more. It uses C++17 standard. The library is licensed under the Apache 2.0 license.
+**plotOpenCv** is a C++ library developed to facilitate the visualization of 2-dimensional line charts. This library is built upon the OpenCV, providing users with a convenient and efficient tool for visualizing data through line charts. With **plotOpenCv**, users can effortlessly create multiple line charts within a single window and tune various chart parameters, such as line width, color, and more. It uses C++17 standard. The library is licensed under the Apache 2.0 license.
 
 
 
@@ -40,6 +40,7 @@
 | 1.0.0   | 08.09.2023   | First version.                                               |
 | 1.0.1   | 18.09.2023   | - Update used container for plots.                           |
 | 1.0.2   | 16.04.2024   | - Antialiased line drawing implemented.<br/>- Window size issue fixed.<br/>- Documentation updated. |
+| 1.0.3   | 17.05.2024   | - Documentation updated.                                     |
 
 
 
@@ -123,7 +124,7 @@ std::cout << "plotOpenCv class version: " << plotOpenCv::getVersion() << std::en
 Console output:
 
 ```bash
-plotOpenCv class version: 1.0.2
+plotOpenCv class version: 1.0.3
 ```
 
 
@@ -139,7 +140,7 @@ void addPlot(std::vector<T> &points, int id, int start = 0, int end = 0,
 
 | Parameter | Value                                                        |
 | --------- | ------------------------------------------------------------ |
-| Points    | One dimentional vector which includes vertical points.Vector format : {y1, y2, ... }  |
+| Points    | One dimensional vector which includes vertical points.Vector format : {y1, y2, ... }  |
 | id        | Identifier for chart on a window. Provides user to update a chart or add new one.  |
 | start     | Start index of plot from vector when user wants to plot a specific range from a dataset. Should be 0 for whole dataset.|
 | end       | End index of plot from vector when user wants to plot a specific range from a dataset. Should be 0 for whole dataset. |
@@ -159,12 +160,12 @@ void addPlot(std::vector<std::vector<T>> &points, int id, int start = 0, int end
 
 | Parameter | Value                                                        |
 | --------- | ------------------------------------------------------------ |
-| Points    | Two dimentional vector which includes vertical and horizontal points. Vector format : {{x1,y1}, {x2,y2}, ... } |
+| Points    | Two dimensional vector which includes vertical and horizontal points. Vector format : [{x1,y1}, {x2,y2}, ... ] |
 | id        | Identifier for chart on a window. Provides user to update a chart or add new one.  |
 | start     | Start index of plot from vector when user wants to plot a specific range from a dataset. Should be 0 for whole dataset.|
 | end       | End index of plot from vector when user wants to plot a specific range from a dataset. Should be 0 for whole dataset. |
 | color     | Color of chart line. |
-| tickness  | Tickness of chart line.|
+| thickness | Thickness of chart line.|
 
 
 **Table 2** - Supported data types.
@@ -221,10 +222,10 @@ void clean();
 
 # Example Charts
 
-![plot_opencv_example_1](_static/plot_opencv_example_1.png)
-![plot_opencv_example_2](_static/plot_opencv_example_2.png)
-![plot_opencv_example_3](_static/plot_opencv_example_3.png)
-![plot_opencv_example_combined](_static/plot_opencv_example_combined.png)
+![plot_opencv_example_1](./static/plot_opencv_example_1.png)
+![plot_opencv_example_2](./static/plot_opencv_example_2.png)
+![plot_opencv_example_3](./static/plot_opencv_example_3.png)
+![plot_opencv_example_combined](./static/plot_opencv_example_combined.png)
 
 
 

diff --git a/plotOpenCv_C++_library_v1.0.2.pdf → plotOpenCv_C++_library_v1.0.3.pdf b/plotOpenCv_C++_library_v1.0.2.pdf → plotOpenCv_C++_library_v1.0.3.pdf
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.13)
 ## LIBRARY-PROJECT
 ## name and version
 ###############################################################################
-project(plotOpenCv VERSION 1.0.2 LANGUAGES CXX)
+project(plotOpenCv VERSION 1.0.3 LANGUAGES CXX)
 
 
 

diff --git a/src/plotOpenCvVersion.h b/src/plotOpenCvVersion.h
@@ -2,6 +2,6 @@
 
 #define PLOT_OPENCV_MAJOR_VERSION 1
 #define PLOT_OPENCV_MINOR_VERSION 0
-#define PLOT_OPENCV_PATCH_VERSION 2
+#define PLOT_OPENCV_PATCH_VERSION 3
 
-#define PLOT_OPENCV_VERSION "1.0.2"
+#define PLOT_OPENCV_VERSION "1.0.3"
diff --git a/_static/plot_opencv_example_1.png → static/plot_opencv_example_1.png b/_static/plot_opencv_example_1.png → static/plot_opencv_example_1.png
diff --git a/_static/plot_opencv_example_2.png → static/plot_opencv_example_2.png b/_static/plot_opencv_example_2.png → static/plot_opencv_example_2.png
diff --git a/_static/plot_opencv_example_3.png → static/plot_opencv_example_3.png b/_static/plot_opencv_example_3.png → static/plot_opencv_example_3.png
diff --git a/_static/plot_opencv_example_combined.png → static/plot_opencv_example_combined.png b/_static/plot_opencv_example_combined.png → static/plot_opencv_example_combined.png
diff --git a/_static/plot_opencv_logo.png → static/plot_opencv_logo.png b/_static/plot_opencv_logo.png → static/plot_opencv_logo.png