From b5dec1143e12ab6450db0056f2f76ff66b0e3681 Mon Sep 17 00:00:00 2001 From: e Date: Sat, 18 Nov 2023 20:08:31 +0800 Subject: [PATCH 1/2] docs: change some errors --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a91957..cd10a53 100644 --- 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 From b5260b3ce28989820fdcd4350eb7a07db56ca54e Mon Sep 17 00:00:00 2001 From: LibDriver <704839379@qq.com> Date: Sun, 11 Feb 2024 21:45:16 +0800 Subject: [PATCH 2/2] docs: update docs --- README.md | 2 ++ README_de.md | 2 ++ README_ja.md | 2 ++ README_ko.md | 2 ++ README_zh-Hans.md | 2 ++ README_zh-Hant.md | 2 ++ doc/html/index.html | 2 +- doc/mainpage/mainpage.h | 2 +- 8 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5508744..88463ff 100644 --- 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 index e4a3c1c..a4e0e7b 100644 --- a/README_de.md +++ b/README_de.md @@ -49,6 +49,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 index 4d2d81f..ccc0d89 100644 --- a/README_ja.md +++ b/README_ja.md @@ -50,6 +50,8 @@ LibDriver SHT31は、LibDriverによって発売されたSHT31の全機能ドラ ### 使用 +/example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。 + #### example basic ```C diff --git a/README_ko.md b/README_ko.md index 6d55cc9..38517a7 100644 --- a/README_ko.md +++ b/README_ko.md @@ -50,6 +50,8 @@ LibDriver SHT31은 LibDriver에서 출시한 SHT31의 전체 기능 드라이버 ### 사용 +/example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다. + #### example basic ```C diff --git a/README_zh-Hans.md b/README_zh-Hans.md index ba1cf3c..1c3819b 100644 --- a/README_zh-Hans.md +++ b/README_zh-Hans.md @@ -50,6 +50,8 @@ LibDriver SHT31是LibDriver推出的SHT31的全功能驱动，该驱动提供温 ### 使用 +您可以参考/example目录下的编程范例完成适合您的驱动，如果您想要使用默认的编程范例，以下是它们的使用方法。 + #### example basic ```C diff --git a/README_zh-Hant.md b/README_zh-Hant.md index 802a7e7..3984483 100644 --- a/README_zh-Hant.md +++ b/README_zh-Hant.md @@ -50,6 +50,8 @@ LibDriver SHT31是LibDriver推出的SHT31的全功能驅動，該驅動提供溫 ### 使用 +您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。 + #### example basic ```C diff --git a/doc/html/index.html b/doc/html/index.html index 354bf89..32932fc 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -88,7 +88,7 @@
LibDriver SHT31
-

libdriver sht31 is a full function driver of sht31 and it can run in both MCU and Linux platform.

Version
2.0.0
+

LibDriver SHT31 is a full function driver of SHT31 and it can run in both MCU and Linux platform.

Version
2.0.0
Author
Shifeng Li

history

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