From 69cbf05a28a1d66927c80d45b648f489bbcc003f Mon Sep 17 00:00:00 2001 From: e Date: Sat, 18 Nov 2023 19:55:45 +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 10c08949480fcec42ea9baaf45477857b9aa0fb1 Mon Sep 17 00:00:00 2001 From: LibDriver <704839379@qq.com> Date: Sun, 11 Feb 2024 21:32:05 +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 d186348..7cd9c0d 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 828d3b1..ab65f36 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 5f9168d..c00792a 100644 --- a/README_ja.md +++ b/README_ja.md @@ -50,6 +50,8 @@ LibDriver INA219は、LibDriverによって発売されたINA219の全機能ド ### 使用 +/example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。 + #### example basic ```C diff --git a/README_ko.md b/README_ko.md index 37b0ac3..195fb43 100644 --- a/README_ko.md +++ b/README_ko.md @@ -50,6 +50,8 @@ LibDriver INA219는 LibDriver에서 출시한 INA219의 전체 기능 드라이 ### 사용 +/example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다. + #### example basic ```C diff --git a/README_zh-Hans.md b/README_zh-Hans.md index 969f9ad..b0c079e 100644 --- a/README_zh-Hans.md +++ b/README_zh-Hans.md @@ -50,6 +50,8 @@ LibDriver INA219是LibDriver推出的INA219的全功能驱动，该驱动提供 ### 使用 +您可以参考/example目录下的编程范例完成适合您的驱动，如果您想要使用默认的编程范例，以下是它们的使用方法。 + #### example basic ```C diff --git a/README_zh-Hant.md b/README_zh-Hant.md index 519b577..29b464c 100644 --- a/README_zh-Hant.md +++ b/README_zh-Hant.md @@ -50,6 +50,8 @@ LibDriver INA219是LibDriver推出的INA219的全功能驅動，該驅動提供 ### 使用 +您可以參考/example目錄下的程式設計範例完成適合您的驅動，如果您想要使用默認的程式設計範例，以下是它們的使用方法。 + #### example basic ```C diff --git a/doc/html/index.html b/doc/html/index.html index db1c2dc..dea6278 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -88,7 +88,7 @@
LibDriver INA219
-

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

Version
1.0.0
+

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

Version
1.0.0
Author
Shifeng Li

history

diff --git a/doc/mainpage/mainpage.h b/doc/mainpage/mainpage.h index b4afbae..e786de9 100644 --- a/doc/mainpage/mainpage.h +++ b/doc/mainpage/mainpage.h @@ -1,6 +1,6 @@ /** * @mainpage LibDriver INA219 - * @brief libdriver ina219 is a full function driver of ina219 and it can run in both MCU and Linux platform. + * @brief LibDriver INA219 is a full function driver of INA219 and it can run in both MCU and Linux platform. * @version 1.0.0 * @author Shifeng Li *