# 文档导航

这里放的是 `eltdx` 的使用文档。

如果你只是想安装、调用接口、看字段、排查问题，看这几份就够了。

## 推荐阅读顺序

### 1. 先看项目首页

- [`../README.md`](../README.md)
- 适合先快速了解这个库能做什么、怎么安装、怎么开始用

### 2. 再看 API 用法

- [`API_REFERENCE.md`](./API_REFERENCE.md)
- 想查函数参数、返回值、初始化方式，就看这份

### 3. 然后看使用示例

- [`EXAMPLES.md`](./EXAMPLES.md)
- 想直接复制代码改一改就跑，就看这份

### 4. 如果你卡在字段含义

- [`FIELD_REFERENCE.md`](./FIELD_REFERENCE.md)
- 想知道某个字段是什么意思、原始值怎么换算，就看这份

### 5. 如果你要排查问题

- [`DEBUG_GUIDE.md`](./DEBUG_GUIDE.md)
- 想看 raw 数据、指定服务器、查常见问题，就看这份

## 按需求找文档

### 我想知道“某个函数怎么用”

看：[`API_REFERENCE.md`](./API_REFERENCE.md)

### 我想直接复制一段代码开始用

看：[`EXAMPLES.md`](./EXAMPLES.md)

### 我想知道“某个字段是什么意思”

看：[`FIELD_REFERENCE.md`](./FIELD_REFERENCE.md)

### 我想看看原始十六进制、或者排查连接问题

看：[`DEBUG_GUIDE.md`](./DEBUG_GUIDE.md)

## 文档地图

| 文档 | 作用 |
| --- | --- |
| [`../README.md`](../README.md) | 项目首页 |
| [`API_REFERENCE.md`](./API_REFERENCE.md) | API 用法总表 |
| [`EXAMPLES.md`](./EXAMPLES.md) | 可直接运行的示例 |
| [`FIELD_REFERENCE.md`](./FIELD_REFERENCE.md) | 字段说明 |
| [`DEBUG_GUIDE.md`](./DEBUG_GUIDE.md) | 调试指南 |
