docs: add readme
This commit is contained in:
parent
cff99e325f
commit
15a9e03b85
61
README.cn.md
Normal file
61
README.cn.md
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
# 关于
|
||||||
|
|
||||||
|
FwLib_STC8 是面向 STC8G/STC8H 系列 MCU 的C语言封装库
|
||||||
|
|
||||||
|
# 特性
|
||||||
|
|
||||||
|
* 与 SDCC 和 Keil C51 兼容
|
||||||
|
* 为8位MCU的受限资源优化
|
||||||
|
* 以易读的代码形式提供片上资源的操作
|
||||||
|
* 丰富的演示例程用于快速上手
|
||||||
|
|
||||||
|
# PlatformIO 快速上手
|
||||||
|
|
||||||
|
1. 将代码仓库克隆到本地目录
|
||||||
|
```bash
|
||||||
|
# GitHub
|
||||||
|
git clone https://github.com/IOsetting/FwLib_STC8.git FwLib_STC8
|
||||||
|
# or Giteee (for Chinese users)
|
||||||
|
git clone https://gitee.com/iosetting/fw-lib_-stc8.git FwLib_STC8
|
||||||
|
```
|
||||||
|
2. 复制(或移动)到 PlatformIO 项目的lib目录下
|
||||||
|
```
|
||||||
|
├── include
|
||||||
|
├── lib
|
||||||
|
│ └── FwLib_STC8
|
||||||
|
│ ├── demo
|
||||||
|
│ ├── include
|
||||||
|
│ └── src
|
||||||
|
├── src
|
||||||
|
└── test
|
||||||
|
```
|
||||||
|
3. 在代码中引用 `fw_hal.h`后, 就可以开始使用了
|
||||||
|
```c
|
||||||
|
#include "fw_hal.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
4. 更多的使用细节, 请查看demo中的例程代码.
|
||||||
|
|
||||||
|
|
||||||
|
# Keil C51 快速上手
|
||||||
|
|
||||||
|
1. 将代码仓库克隆到本地目录
|
||||||
|
```bash
|
||||||
|
# GitHub
|
||||||
|
git clone https://github.com/IOsetting/FwLib_STC8.git FwLib_STC8
|
||||||
|
# or Giteee (for Chinese users)
|
||||||
|
git clone https://gitee.com/iosetting/fw-lib_-stc8.git FwLib_STC8
|
||||||
|
```
|
||||||
|
2. 复制(或移动)到 Keil C51 项目目录下
|
||||||
|
3. 将其通过 Project -> Manage -> Project Items, 添加到项目文件中
|
||||||
|
4. 在代码中引用 `fw_hal.h`后, 就可以开始使用了
|
||||||
|
```c
|
||||||
|
#include "fw_hal.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# 授权
|
||||||
|
|
||||||
|
Copyright (c) 2021-present IOsetting <iosetting@outlook.com>
|
||||||
|
|
||||||
|
FwLib_STC8 使用 Apache 2.0 协议授权, 可以使用于个人及商业项目.
|
63
README.md
63
README.md
@ -0,0 +1,63 @@
|
|||||||
|
# About
|
||||||
|
|
||||||
|
FwLib_STC8 is a lite firmware library for STC8G/STC8H series MCU.
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
|
* Compatible with SDCC and Keil C51
|
||||||
|
* Optimized for constrained 8-bit MCU resources
|
||||||
|
* Readable code for on-chip resources operation
|
||||||
|
* Demos for quick start
|
||||||
|
|
||||||
|
# PlatformIO Quick Start
|
||||||
|
|
||||||
|
1. Clone this repository to local file system
|
||||||
|
```bash
|
||||||
|
# GitHub
|
||||||
|
git clone https://github.com/IOsetting/FwLib_STC8.git FwLib_STC8
|
||||||
|
# or Giteee (for Chinese users)
|
||||||
|
git clone https://gitee.com/iosetting/fw-lib_-stc8.git FwLib_STC8
|
||||||
|
```
|
||||||
|
2. Copy(or move) it to your PlatformIO project library, the file structure
|
||||||
|
```
|
||||||
|
├── include
|
||||||
|
├── lib
|
||||||
|
│ └── FwLib_STC8
|
||||||
|
│ ├── demo
|
||||||
|
│ ├── include
|
||||||
|
│ └── src
|
||||||
|
├── src
|
||||||
|
└── test
|
||||||
|
```
|
||||||
|
3. Include `fw_hal.h` in your code
|
||||||
|
```c
|
||||||
|
#include "fw_hal.h"
|
||||||
|
```
|
||||||
|
then it's ready to use.
|
||||||
|
|
||||||
|
4. For more detailed usage, please check the code in demos
|
||||||
|
|
||||||
|
|
||||||
|
# Keil C51 Quick Start
|
||||||
|
|
||||||
|
1. Clone this repository to local file system
|
||||||
|
```bash
|
||||||
|
# GitHub
|
||||||
|
git clone https://github.com/IOsetting/FwLib_STC8.git FwLib_STC8
|
||||||
|
# or Giteee (for Chinese users)
|
||||||
|
git clone https://gitee.com/iosetting/fw-lib_-stc8.git FwLib_STC8
|
||||||
|
```
|
||||||
|
2. Copy(or move) it to your Keil C51 project directory,
|
||||||
|
3. Add it to project through Project -> Manage -> Project Items,
|
||||||
|
4. Include `fw_hal.h` in your code
|
||||||
|
```c
|
||||||
|
#include "fw_hal.h"
|
||||||
|
```
|
||||||
|
then it's ready to use.
|
||||||
|
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
Copyright (c) 2021-present IOsetting <iosetting@outlook.com>
|
||||||
|
|
||||||
|
The FwLib_STC8 is licensed under the permissive Apache 2.0 license, you can use it in both commercial and personal projects with confidence.
|
Loading…
Reference in New Issue
Block a user