libs
/
FlashDB
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the docs for linux.

This commit is contained in:
armink 2021-01-03 23:09:23 +08:00
parent 60cee13a1d
commit 9537810b7b
8 changed files with 62 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,6 +1,6 @@
![](docs/_media/flashdb.png) ![](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) [![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) [![docs](https://img.shields.io/badge/docs-perfect-blue)](https://armink.github.io/FlashDB/#/)
EN | [中文](README_zh.md) EN | [中文](README_zh.md)

2
README_zh.md
View File

@ -1,6 +1,6 @@
![](docs/_media/flashdb.png) ![](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) [![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) [![docs](https://img.shields.io/badge/docs-perfect-blue)](http://armink.gitee.io/flashdb/#/zh-cn/ )
[EN](README.md) | 中文 [EN](README.md) | 中文

1
docs/_sidebar.md
View File

@ -5,6 +5,7 @@
- [stm32f405rg](demo-stm32f405rg.md) - [stm32f405rg](demo-stm32f405rg.md)
- [stm32f405rg-spi-flash](demo-stm32f405rg-spi-flash.md) - [stm32f405rg-spi-flash](demo-stm32f405rg-spi-flash.md)
- [esp8266-spi-flash](demo-esp8266-spi-flash.md) - [esp8266-spi-flash](demo-esp8266-spi-flash.md)
- [linux](demo-linux.md)
- [Demo details](demo-details.md) - [Demo details](demo-details.md)
- Samples - Samples
- KV database - KV database

19
docs/demo-linux.md Normal file
View File

@ -0,0 +1,19 @@
# linux demo
## What
KVDB and TSDB demo on linux platform
## How
### Step1: build
Run `make` command on terminal. The generated executable program is located in the `out` folder.
### Step2: run demo
Switch to the `out` folder. Then run the `./FlashDBLinuxDemo` file multiple times.
### Step3: check the log
This demo's log will output to terminal.

19
docs/quick-started.md
View File

@ -39,23 +39,24 @@ The latest code is currently hosted on GitHub. The master branch is the developm
## Choose a demo platform ## Choose a demo platform
In the `demos` directory of the project, the following hardware demonstration platforms are currently provided. You can choose a hardware platform and experience the running process of FlashDB on a real machine. In the `demos` directory of the project, the following demonstration platforms are currently provided. You can choose a platform and experience the running process of FlashDB on a real machine.
For more detailed introduction, click on the **instructions** in the table below to view. For more detailed introduction, click on the **instructions** in the table below to view.
| Hardware Platform | Path | Flash Type | Instructions | | Platform | Path | Storage Type | Instructions |
| --------------------- | ----------------------------- | :------------ | ---------------------------------------------- | | --------------------- | ----------------------------- | :------------------ | ---------------------------------------------- |
| stm32f10x | `demos/stm32f103ve` | stm32 on-chip | [click to view](demo-stm32f103ve.md) | | stm32f10x | `demos/stm32f103ve` | stm32 on-chip flash | [click to view](demo-stm32f103ve.md) |
| stm32f40x | `demos/stm32f405rg` | stm32 on-chip | [click to view](demo-stm32f405rg.md) | | stm32f40x | `demos/stm32f405rg` | stm32 on-chip flash | [click to view](demo-stm32f405rg.md) |
| stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [click to view](demo-stm32f405rg-spi-flash.md) | | stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [click to view](demo-stm32f405rg-spi-flash.md) |
| esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [click to view](demo-esp8266-spi-flash.md) | | esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [click to view](demo-esp8266-spi-flash.md) |
| linux | `demos/linux` | posix file | [click to view](demo-linux.md) |
## View sample description ## View sample description
If you don't have a suitable demo platform above, you can also check the example instructions you are interested in first. If you don't have a suitable demo platform above, you can also check the example instructions you are interested in first.
| Sample file | Description | Detailed explanation | | Sample file | Description | Detailed explanation |
| ----------------------------------- | ------------------------- | ---------------------------------------------- | | ----------------------------------- | ------------------------- | ---------------------------------------- |
| `samples/kvdb_basic_sample.c` | KVDB basic example | [click to view](sample-kvdb-basic) | | `samples/kvdb_basic_sample.c` | KVDB basic example | [click to view](sample-kvdb-basic) |
| `samples/kvdb_type_string_sample.c` | KV example of string type | [click to view](sample-kvdb-type-string) | | `samples/kvdb_type_string_sample.c` | KV example of string type | [click to view](sample-kvdb-type-string) |
| `samples/kvdb_type_blob_sample.c` | Blob type KV example | [click to view](sample-kvdb-type-blob) | | `samples/kvdb_type_blob_sample.c` | Blob type KV example | [click to view](sample-kvdb-type-blob) |

1
docs/zh-cn/_sidebar.md
View File

@ -5,6 +5,7 @@
- [stm32f405rg](zh-cn/demo-stm32f405rg.md) - [stm32f405rg](zh-cn/demo-stm32f405rg.md)
- [stm32f405rg-spi-flash](zh-cn/demo-stm32f405rg-spi-flash.md) - [stm32f405rg-spi-flash](zh-cn/demo-stm32f405rg-spi-flash.md)
- [esp8266-spi-flash](zh-cn/demo-esp8266-spi-flash.md) - [esp8266-spi-flash](zh-cn/demo-esp8266-spi-flash.md)
- [linux](zh-cn/demo-linux.md)
- [演示说明](zh-cn/demo-details.md) - [演示说明](zh-cn/demo-details.md)
- 示例 - 示例
- 键值数据库 - 键值数据库

21
docs/zh-cn/demo-linux.md Normal file
View File

@ -0,0 +1,21 @@
# linux demo
## 介绍
基于 Linux 平台的 KVDB 和 TSDB 演示。
## 使用
### 步骤1：构建
在终端中执行 `make` 命令，完成后，`out` 文件夹下将会生成可执行程序文件。
### 步骤2：运行演示
切换到 `out` 文件夹下，然后可多次执行 `./FlashDBLinuxDemo` 。
### 步骤3：检查日志
演示的日志将会输出在终端中，可以进行检查。
> PS: 演示工程代码及日志分析，详见：入门 -> [演示说明文档](zh-cn/demo-details.md)

15
docs/zh-cn/quick-started.md
View File

@ -40,16 +40,17 @@ FlashDB 提供的演示工程默认支持两种工程：
## 选择演示平台 ## 选择演示平台
在项目的 `demos` 目录下，目前已提供下面一些硬件演示平台，可以选择一个硬件平台，真机体验一下 FlashDB 的运行过程。 在项目的 `demos` 目录下，目前已提供下面一些演示平台，可以选择一个平台，真机体验一下 FlashDB 的运行过程。
更多详细介绍，点击下方表格中的 **使用说明** 进行查看。 更多详细介绍，点击下方表格中的 **使用说明** 进行查看。
| 硬件平台 | 路径 | flash 类型 | 使用说明 | | 硬件平台 | 路径 | 存储类型 | 使用说明 |
| --------------------- | :---------------------------- | :------------ | ----------------------------------------------- | | --------------------- | :---------------------------- | :------------------ | ----------------------------------------------- |
| stm32f10x | `demos/stm32f103ve` | stm32 on-chip | [点击查看](zh-cn/demo-stm32f103ve.md) | | stm32f10x | `demos/stm32f103ve` | stm32 on-chip flash | [点击查看](zh-cn/demo-stm32f103ve.md) |
| stm32f40x | `demos/stm32f405rg` | stm32 on-chip | [点击查看](zh-cn/demo-stm32f405rg.md) | | stm32f40x | `demos/stm32f405rg` | stm32 on-chip flash | [点击查看](zh-cn/demo-stm32f405rg.md) |
| stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [点击查看](zh-cn/demo-stm32f405rg-spi-flash.md) | | stm32f40x + spi flash | `demos/stm32f405rg_spi_flash` | spi flash | [点击查看](zh-cn/demo-stm32f405rg-spi-flash.md) |
| esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [点击查看](zh-cn/demo-esp8266-spi-flash.md) | | esp8266 + spi flash | `demos/esp8266_spi_flash` | spi flash | [点击查看](zh-cn/demo-esp8266-spi-flash.md) |
| linux | `demos/linux` | posix file | [点击查看](zh-cn/demo-linux.md) |
## 查看示例说明 ## 查看示例说明