在Github的readme里添加注释

最新推荐文章于 2024-04-29 15:29:14 发布
最新推荐文章于 2024-04-29 15:29:14 发布
阅读量1.4k 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tailonh/article/details/116707752
版权

如下所示：

<!---
<p><img align="center" src="https://github-readme-streak-stats.herokuapp.com/?user=tyistyler&" alt="tyistyler" /></p>
-->
想念@思恋
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
自述文件：README文件的示例以及有关如何编写它们的注释
02-04
自述文件：README文件的示例以及有关如何编写它们的注释
github相关操作&注释规范记录
FUNNY123
05-04 353
github相关操作&注释规范记录
Git远程仓库及github的使用备注
Sunlight
02-09 2868
远程仓库： 第1步：创建SSH Key。在用户主目录下，看看有没有.ssh目录，如果有，再看看这个目录下有没有id_rsa和id_rsa.pub这两个文件， 如果已经有了，可直接跳到下一步。如果没有，打开Shell（Windows下打开Git Bash），创建SSH Key：$ ssh-keygen -t rsa -C "youremail@example.com" 你需要把邮件地址换成你
readme
weixin_44081243的博客
03-17 7747
README（注释和说明文档） 1. 为什么要有README文档** 简评：因为 README，6 个月后的你仍然知道当初写了什么；因为 README，其他人看一眼就能知道是否需要；因为 README，让你的代码更有质量；因为 README，你成了个作家。 README 是一种说明文件，通常随着一个软件而发布，里面记载有软件的描述或注意事项。这种档案通常是一个纯文字文件，被命名README....
README
qq906396583的博客
03-07 300
#YFRobot arduino库-mixly版 ##YFRobot libary for mixly. Author :yfrobot website: http://www.yfrobot.com Test on mixly V0.996 ###使用方法 1.打开mixly软件，点击"导入库/Import"。 2.选中yfrobot文件夹中的yfrobot.xml文件，提示导入成功即可。...
actions-readme-feed:在您的GitHub个人资料自述文件中显示RSS feed
03-20
用法首先，将标记注释添加到文档中所需的位置： ### Latest Posts<!-- feed start --><!-- feed end -->然后将以下步骤添加到您的工作流程： steps : - uses : actions/checkout@v2 - uses : sarisia/...
README：README文件语法解释，即Github Flavored Markdown语法介绍
02-03
8. **脚注**：GFM支持添加注释，提供额外的信息。 9. **插入表情符号**：通过`:emoji_name:`可以插入各种表情符号。 **创建有效的README** 一个优秀的README文件应该包含以下几个部分： 1. **项目标题**：简洁...
github-activity-readme:使用用户的最近GitHub活动更新README
03-20
在README.md添加注释<!--START_SECTION:activity--> （入口点）。您可以找到示例。 现在是创建工作流文件的时候了。 .github/workflows/update-readme.yml name : Update README on : schedule : - cron :...
Readme-2048:在自述文件上玩著名的2048游戏。 该游戏可直接在GitHub存储库上玩。 每个人都可以采取行动
04-13
该模板存储库包含Python 2048自动bot的源代码以及GitHub Workflow，以允许ANYONE播放README文件中的2048。 想要看到这个动作吗？ 转到我的个人资料页面，随时可以自己尝试！ 制作自己的仓库的步骤 点击"Use this ...
readme-generator：自动将那些无聊的纯文本自述文件自动转换为github markdown
02-04
＃readme-generator 自动将那些无聊的纯文本自述文件转换为GitHub markdown。... 除非存在“ BEGIN READMELANG”和“ END READMELANG”注释标签，否则添加到文件末尾（如果适用，则在贡献者数据之前）。 -C 将贡
LaserNet README批注
发布工作学习过程中遇到的问题和解决方案
06-03 389
LaserNet README批注LaserNet in Tensorflow 2.0环境配置Instructions:What works:What's still not done:Example Results LaserNet in Tensorflow 2.0 In this project I’ve done my best to implement the work from Uber ATG on LaserNet. LaserNet is a 3D object detector for
好看又规范的Github Readme 制作指南
m0_56661101的博客
03-21 2050
精心设计的 README 对于任何 GitHub 存储库都至关重要，因为它是潜在用户和贡献者的主要信息来源。以下是创建 README 时要遵循的基本结构。
README.md编写和格式语法——入门
最新发布
m0_68747642的博客
04-29 1439
创建标题前加#符号来决定标题的大小。
Gitee操作指南
quanyu7121的博客
06-07 335
Gitee操作指南
GitHub上README写法暨GFM语法解读
weixin_30730053的博客
04-15 2702
转载请保留原作者guodongxiaren的原文地址。 自从开始玩GitHub以来，就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴，帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写，markdown是一种编辑博客的语言。用惯了可视化的博客编辑器（比如CSDN博客，囧），这种编程式的博客编辑方案着实...
gitHub中readme.md编写语法
Alisane的博客
09-17 3211
1.标题表示法:分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。注意：#与标题名中间的空格 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 2.换行： 在你想换行的地方加一个&lt...
github上面如何编辑README
热门推荐
码莎拉蒂
11-09 1万+
github上面如何编辑README 今天把自己做好的《手机摇一摇震动刷新（支持ListView、GridView、Webview）》上传到github,之前代码都上传好了，就差介绍了 第一步：找到READM.md文件进入编辑状态 找到了READM.md文件，修改一番以后，我想试下水，先提交看看，如下图 感觉还行，然后我想修改里面的内容添加gif图
前端写README.MD的最全Markdown使用帮助
哈哈hyc的博客
10-24 2095
# 欢迎使用Markdown编辑器写博客 --------------------------- 撤销：Ctrl/Command + Z 重做：Ctrl/Command + Y 加粗：Ctrl/Command + B 斜体：Ctrl/Command + I 标题：Ctrl/Command + Shift + H 无序列表：Ctrl/Command +...
github主页好看的readme
07-28
以下是一些可以使你的 GitHub 主页 README 更加吸引人和专业的建议： 1. 使用标题和子标题：使用 # 标记创建标题和子标题，以使文档结构清晰。 2. 添加标识和徽章：可以在 README 中添加徽章来展示项目的状态、构建状态、代码覆盖率等信息。可以使用 Shields.io 等网站生成这些徽章。 3. 添加项目描述：在 README 开头提供项目的简短描述，介绍项目的目标、用途和特点。 4. 显示项目截图或演示：如果你的项目有界面，可以添加一些截图或者 GIF 动画来展示你的项目。 5. 安装说明：提供详细的安装说明，包括所需的依赖项和如何安装它们。可以使用代码块来展示命令行示例。 6. 使用示例：提供使用示例或者代码片段来演示如何使用你的项目。可以使用代码块或者注释来展示示例代码。 7. 贡献指南：如果你希望其他人为你的项目做出贡献，提供一个贡献指南是很有帮助的。解释如何报告问题、提交请求和运行测试。 8. 许可证信息：在 README 中明确指出你的项目使用的许可证类型。 9. 添加联系方式：提供你的联系方式，以便其他人与你沟通或提供反馈。 10. 更新日志：如果你的项目有版本更新，可以在 README 中记录更新日志，包括每个版本的改动和修复。 以上是一些可以使你的 GitHub 主页 README 更加好看和有吸引力的建议，希望对你有所帮助！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值