Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs #19

Merged
merged 2 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,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
Expand Down
2 changes: 2 additions & 0 deletions README_de.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,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
Expand Down
2 changes: 2 additions & 0 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ LibDriver ADXL345は、LibDriverによって起動されたadxl345の全機能

### 使用

/example ディレクトリ内のサンプルを参照して、独自のドライバーを完成させることができます。 デフォルトのプログラミング例を使用したい場合の使用方法は次のとおりです。

#### example basic

```C
Expand Down
2 changes: 2 additions & 0 deletions README_ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ LibDriver ADXL345는 LibDriver에서 출시한 adxl345의 전체 기능 드라

### 사용

/example 디렉터리의 예제를 참조하여 자신만의 드라이버를 완성할 수 있습니다. 기본 프로그래밍 예제를 사용하려는 경우 사용 방법은 다음과 같습니다.

#### example basic

```C
Expand Down
2 changes: 2 additions & 0 deletions README_zh-Hans.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ LibDriver ADXL345是LibDriver推出的ADXL345的全功能驱动,该驱动提

### 使用

您可以参考/example目录下的编程范例完成适合您的驱动,如果您想要使用默认的编程范例,以下是它们的使用方法。

#### example basic

```C
Expand Down
2 changes: 2 additions & 0 deletions README_zh-Hant.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ LibDriver ADXL345是LibDriver推出的ADXL345的全功能驅動,該驅動提

### 使用

您可以參考/example目錄下的程式設計範例完成適合您的驅動,如果您想要使用默認的程式設計範例,以下是它們的使用方法。

#### example basic

```C
Expand Down
2 changes: 1 addition & 1 deletion doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
<div class="title">LibDriver ADXL345 </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>libdriver adxl345 is a full function driver of adxl345 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 ADXL345 is a full function driver of ADXL345 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">
Expand Down
2 changes: 1 addition & 1 deletion doc/mainpage/mainpage.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @mainpage LibDriver ADXL345
* @brief libdriver adxl345 is a full function driver of adxl345 and it can run in both MCU and Linux platform.
* @brief LibDriver ADXL345 is a full function driver of ADXL345 and it can run in both MCU and Linux platform.
* @version 2.0.0
* @author Shifeng Li
*
Expand Down