[CHANGE] README to markdown

This commit is contained in:
xudx 2024-11-01 08:43:20 +08:00
parent 65fd609997
commit ace20bf7b0
3 changed files with 12 additions and 14 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
*build*

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# 文件说明:(每个文件下文件命名需要符合规范)
1. app: 放置样业务代码每个业务分为两个文件文件命名如下app_xxx.c、app_xxx.h
2. model放置二次封装的代码主要是模块功能例如实时库mdl_xxx.c,mdl_xxx.h
3. drv:放置驱动层代码(例如drv_tcp.c,drv_tcp.h)
4. kit放置一些自定义的组件例如封装事件时间函数等kit_xxx.hkit_xxx.c
5. lib放置一些库以及相关头文件lib中可建立不同库的文件夹,
6. utils表示工具类代码通常是一些辅助功能,例如uls_xxx.h,uls_xxx.c
7. alg表示业务策略代码,例如uls_xxx.h,uls_xxx.c
8. protocol表示南北向协议,例如proto_xxx.h,proto_xxx.c
9. scripts开发过程中或者搭建开发环境是常用的安装库说明记录用的

14
readMe
View File

@ -1,14 +0,0 @@
文件说明:(每个文件下文件命名需要符合规范)
1、app放置样业务代码每个业务分为两个文件文件命名如下app_xxx.c、app_xxx.h
2、model放置二次封装的代码主要是模块功能例如实时库mdl_xxx.c,mdl_xxx.h
3、drv:放置驱动层代码(例如drv_tcp.c,drv_tcp.h)
4、kit放置一些自定义的组件例如封装事件时间函数等kit_xxx.hkit_xxx.c
5、lib放置一些库以及相关头文件lib中可建立不同库的文件夹,
6、utils表示工具类代码通常是一些辅助功能,例如uls_xxx.h,uls_xxx.c
7、alg表示业务策略代码,例如uls_xxx.h,uls_xxx.c
8、protocol表示南北向协议,例如proto_xxx.h,proto_xxx.c
9、scripts开发过程中或者搭建开发环境是常用的安装库说明记录用的