From 110d643e0d22421db79de5e81a8024fcd4afb262 Mon Sep 17 00:00:00 2001 From: armink Date: Thu, 8 Oct 2020 15:47:33 +0800 Subject: [PATCH] [docs] update the README_zh.md. --- README.md => README_zh.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) rename README.md => README_zh.md (63%) diff --git a/README.md b/README_zh.md similarity index 63% rename from README.md rename to README_zh.md index 92b4285..d567b4a 100644 --- a/README.md +++ b/README_zh.md @@ -1,7 +1,9 @@ -# FlashDB：超轻量级嵌入式数据库 +![](docs/_media/flashdb.png) [![Build Status](https://travis-ci.com/armink/FlashDB.svg?branch=master)](https://travis-ci.com/armink/FlashDB) [![license](https://img.shields.io/github/license/armink/FlashDB)](https://raw.githubusercontent.com/armink/FlashDB/master/LICENSE) +[EN](README.md) | 中文 + ## 简介 [FlashDB](https://github.com/armink/FlashDB) 是一款超轻量级的嵌入式数据库，专注于提供嵌入式产品的数据存储方案。与传统的基于文件系统的数据库不同，[FlashDB](https://github.com/armink/FlashDB) 结合了 Flash 的特性，具有较强的性能及可靠性。并在保证极低的资源占用前提下，尽可能延长 Flash 使用寿命。 @@ -70,26 +72,14 @@ Query total spent 1475 (ms) for 13422 TSL, min 0, max 1, average: 0.11 ms/per ## 如何使用 -### 移植 +FlashDB 提供了全面的文档说明，详见：http://armink.gitee.io/flashdb/#/zh-cn/ -FlashDB 底层的 Flash 管理及操作依赖于 RT-Thread 的 FAL (Flash Abstraction Layer) Flash 抽象层开源软件包 ，该开源库也支持运行在 **裸机平台** [(点击查看介绍)](http://packages.rt-thread.org/detail.html?package=fal)。所以只需要将所用到的 Flash 对接到 FAL ，即可完成整个移植工作。 +快速访问： - FAL 移植主要流程： - -- 定义 flash 设备，详见 ([GitHub](https://github.com/RT-Thread-packages/fal#21%E5%AE%9A%E4%B9%89-flash-%E8%AE%BE%E5%A4%87)|[Gitee](https://gitee.com/RT-Thread-Mirror/fal#21%E5%AE%9A%E4%B9%89-flash-%E8%AE%BE%E5%A4%87)) -- 定义 flash 设备表，详见 ([GitHub](https://github.com/RT-Thread-packages/fal#22%E5%AE%9A%E4%B9%89-flash-%E8%AE%BE%E5%A4%87%E8%A1%A8)|[Gitee](https://gitee.com/RT-Thread-Mirror/fal#22%E5%AE%9A%E4%B9%89-flash-%E8%AE%BE%E5%A4%87%E8%A1%A8)) -- 定义 flash 分区表，详见 ([GitHub](https://github.com/RT-Thread-packages/fal#23%E5%AE%9A%E4%B9%89-flash-%E5%88%86%E5%8C%BA%E8%A1%A8)|[Gitee](https://gitee.com/RT-Thread-Mirror/fal#23%E5%AE%9A%E4%B9%89-flash-%E5%88%86%E5%8C%BA%E8%A1%A8)) - -### 示例 - -FlashDB 提供了主要功能的示例，直接加入工程即可运行，并具有一定的参考性 - -| 文件路径 | 介绍 | 备注 | -| ------------------------------------------------------------ | --------------------------------------- | ---- | -| [`samples/kvdb_basic_sample.c`](samples/kvdb_basic_sample.c) | KVDB 基础示例，获取当前启动次数 | | -| [`samples/kvdb_type_string_sample.c`](samples/kvdb_type_string_sample.c) | KVDB 使用字符型键值的示例 | | -| [`samples/kvdb_type_blob_sample.c`](samples/kvdb_type_blob_sample.c) | KVDB 使用 blob 型（任意类型）键值的示例 | | -| [`samples/tsdb_sample.c`](samples/tsdb_sample.c) | TSDB 示例 | | +- [快速上手文档](http://armink.gitee.io/flashdb/#/zh-cn/quick-started) +- [移植文档](http://armink.gitee.io/flashdb/#/zh-cn/porting) +- [配置文档](http://armink.gitee.io/flashdb/#/zh-cn/configuration) +- [API 文档](http://armink.gitee.io/flashdb/#/zh-cn/api) ## 支持