Merge pull request #11 from libdriver/dev

docs: update docs
libdriver · Feb 12, 2024 · 543c967 · 543c967
2 parents 132c485 + d92511e
commit 543c967
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1992,7 +1992,7 @@ CMakeLists.txt needs to follow the LibDriver CMake style and its content is as f
     # set the package depends
     set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6")
     
-    # .tar.gz outpout
+    # .tar.gz output
     # set(CPACK_GENERATOR TGZ)
     
     # set the package name

diff --git a/README.md b/README.md
@@ -50,6 +50,8 @@ Add /src, /interface and /example to your project.
 
 ### Usage
 
+You can refer to the examples in the/example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
+
 #### example basic
 
 ```C

diff --git a/README_de.md b/README_de.md
@@ -50,6 +50,8 @@ Fügen Sie /src, /interface und /example zu Ihrem Projekt hinzu.
 
 ### Nutzung
 
+Sie können auf die Beispiele im Verzeichnis/example zurückgreifen, um Ihren eigenen Treiber zu vervollständigen. Wenn Sie die Standardprogrammierbeispiele verwenden möchten, erfahren Sie hier, wie Sie diese verwenden.
+
 #### example basic
 
 ```C

diff --git a/README_ja.md b/README_ja.md
@@ -50,6 +50,8 @@ LibDriver TCS34725は、LibDriverによって起動されたTCS34725の全機能
 
 ### 使用
 
+/example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。
+
 #### example basic
 
 ```C

diff --git a/README_ko.md b/README_ko.md
@@ -50,6 +50,8 @@ LibDriver TCS34725는 LibDriver에서 출시한 TCS34725의 전체 기능 드라
 
 ### 사용
 
+/example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다.
+
 #### example basic
 
 ```C

diff --git a/README_zh-Hans.md b/README_zh-Hans.md
@@ -50,6 +50,8 @@ LibDriver TCS34725是LibDriver推出的TCS34725全功能驱动，该驱动提供
 
 ### 使用
 
+您可以参考/example目录下的编程范例完成适合您的驱动，如果您想要使用默认的编程范例，以下是它们的使用方法。
+
 #### example basic
 
 ```C

diff --git a/README_zh-Hant.md b/README_zh-Hant.md
@@ -50,6 +50,8 @@ LibDriver TCS34725是LibDriver推出的TCS34725全功能驅動，該驅動提供
 
 ### 使用
 
+您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。
+
 #### example basic
 
 ```C

diff --git a/doc/html/index.html b/doc/html/index.html
@@ -88,7 +88,7 @@
 <div class="title">LibDriver TCS34725 </div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p>libdriver tcs34725 is a full function driver of tcs34725 and it can run in both MCU and Linux platform. </p><dl class="section version"><dt>Version</dt><dd>2.0.0 </dd></dl>
+<div class="textblock"><p>LibDriver TCS34725 is a full function driver of TCS34725 and it can run in both MCU and Linux platform. </p><dl class="section version"><dt>Version</dt><dd>2.0.0 </dd></dl>
 <dl class="section author"><dt>Author</dt><dd>Shifeng Li</dd></dl>
 <h3>history</h3>
 <table class="doxtable">

diff --git a/doc/mainpage/mainpage.h b/doc/mainpage/mainpage.h
@@ -1,6 +1,6 @@
 /**
  * @mainpage  LibDriver TCS34725
- * @brief     libdriver tcs34725 is a full function driver of tcs34725 and it can run in both MCU and Linux platform.
+ * @brief     LibDriver TCS34725 is a full function driver of TCS34725 and it can run in both MCU and Linux platform.
  * @version   2.0.0
  * @author    Shifeng Li
  *