怎么在项目文件中加入一个readme文档，记录各种修改信息等

caicaptain2 · 发表于 2021-8-23 13:51:46

习惯在项目文件中加入一个文档文件，记做readme。一般都是软件的框架，修改记录。即使在修改代码的时候，也可以随时点开记录信息。
以前都是使用txt文件记录，但是发现一些不方便的地方。比如不能加入框图，不能加入表格。想加入word格式的doc文件，可是默认双击打开就是乱码。。。

大家有好的解决方案吗？

eric2013 · 发表于 2021-8-23 14:14:06

html格式。

www2205290064 · 发表于 2021-8-23 15:23:33

markdown文件

emwin · 发表于 2021-8-23 15:26:33

有版本控制的情况下，建议markdown，可以直接支持阅读

caicaptain2 · 发表于 2021-8-24 09:46:16

www2205290064 发表于 2021-8-23 15:23
markdown文件

mdk可以直读md文件吗？似乎无法显示相应的格式吧？

风来吴山 · 发表于 2021-8-24 15:12:30

caicaptain2 发表于 2021-8-24 09:46
mdk可以直读md文件吗？似乎无法显示相应的格式吧？

只用mdk就会束手束脚。

cjunrong · 发表于 2021-8-24 17:29:11

caicaptain2 发表于 2021-8-24 09:46
mdk可以直读md文件吗？似乎无法显示相应的格式吧？

mdk能打开md文件，不过是按纯文本文件显示，无法解析markdown的语法。

muooooo · 发表于 2021-8-26 09:51:57

用VSCODE编辑KEIL工程,写个小脚本调用keil命令行来编译和烧录,markdown和git全都给安排上

eric2013 · 发表于 2021-8-27 09:07:11

发下word也能导出html文件，也不错

caicaptain2 · 发表于 2021-8-30 11:35:38

eric2013 发表于 2021-8-27 09:07
发下word也能导出html文件，也不错

项目文件夹里面只能加入这些类型文件。什么word，html都不识别。那个image其实也不能识别任何图片文件，jpeg，png都不行。

eric2013 · 发表于 2021-8-31 09:03:26

caicaptain2 发表于 2021-8-30 11:35
项目文件夹里面只能加入这些类型文件。什么word，html都不识别。那个image其实也不能识别任何图片文 ...

那稍有点麻烦了。你的意思是希望MDK也可以识别吗

alexyzhov · 发表于 2021-9-5 01:40:09

用git呀。版本发布走持续集成流程，Jenkins开条pipeline，填完release note后自动给发布时的提交打tag。

caicaptain2 · 发表于 2021-9-6 10:54:02

alexyzhov 发表于 2021-9-5 01:40
用git呀。版本发布走持续集成流程，Jenkins开条pipeline，填完release note后自动给发布时的提交打tag。

我研究过git大概一周左右，还试用了国产的gitee。感觉不适合小型的嵌入式开发。
一个是网上云存储不太安全，就连github都使用上传的代码为AI私用；另一个是开发团队规模很小，基本上用不到同步协调之类的功能。
git的命令行模式也是非常的繁琐，用起来像智力游戏。

kkang · 发表于 2021-9-7 14:12:57

这个问题很好，我也碰到了相同的问题，想在项目文件里加入readme,keil直接点开就能看，目前无奈只能加入文本文档，但表现力实在有限，想画个状态图什么的都不行

alexyzhov · 发表于 2021-9-19 03:02:18

caicaptain2 发表于 2021-9-6 10:54
我研究过git大概一周左右，还试用了国产的gitee。感觉不适合小型的嵌入式开发。
一个是网上云存储不太 ...

习惯就好了，对于一个合格的软件项目，版本管理是必须的。。掌握版本控制工作流衍生出来的额外开销，也是项目开发成本的一部分。。

		自动登录	找回密码
密码			立即注册

[MDK] 怎么在项目文件中加入一个readme文档，记录各种修改信息等