开源项目README建议

最新推荐文章于 2022-04-27 00:56:40 发布
VIP文章 最新推荐文章于 2022-04-27 00:56:40 发布
阅读量570 收藏 2
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhujohnle/article/details/106297637
版权

文章目录

国际化

Github是面向全球的一个开源网站，所以不要局限于中文文档，建议写一个英文的README，让来自全球的人都能更方便的了解你的项目。推荐写法，在REAMDE开头写上国际化引用地址

在这里插入图片描述

项目介绍

项目介绍主要包括项目图标，介绍，项目特点等

项目上面增加一些图标以提高可读性，推荐使用 Shields.io

最低0.47元/天 解锁文章
无己心
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
开源的readme.md编写工具
04-08
开源的readme.md编写工具。windows平台
一文带你写好：项目说明文档README.md
最新发布
Diligence is the mother of success.
05-07 2206
1、前言公开项目中，一个好的 README 能帮助我们的公开项目，在 GitHub 上的众多项目和开发人员中脱颖而出；商业项目中，一个好的 README 能帮助部门同事更好理解用途和项目进展。下面我们一起讨论什么是 README 自述文件以及如何编写 README 自述文件。2、什么是 README 自述文件？简而言之，大体上有两个定义：可以将 README 文件描述为指南文件，为用户提供项目的详...
软件项目规范（1）：README文件的基本写作规范
热门推荐
星羽空间
04-27 1万+
软件项目规范（1）：README文件的基本写作规范 本博客推出一款简约风格的README.md模板
gitstarted：GitStarted是在GitHub上探索开源项目的理想场所。 根据您过去的开源贡献经验获得项目建议
02-04
GitStarted是在GitHub上探索开源项目的理想场所。 仅通过使用GitHub凭据登录，即可根据您过去的开源贡献获得项目建议。 根据您使用的语言，在您自己的/已贡献存储库中拥有的星号和叉子的数量，我们向您显示一个满足...
PyQtRPT:Pyside QtRPT-开源
04-24
XML格式的报表设计器使创建报表XML文件变得容易QtRPT（http://www.qtrpt.tk/index.php）建议：请使用QtRptDesigner->编辑xml文件来阅读“ readme.txt”文件。重要信息：从Qt5.12开始，该软件包必须具有相同的版本，...
evrone_opensource:改进开源项目的自述文件
05-23
改进开源项目的自述文件。 该项目扫描GitHub和其他来源以寻找可以改善README.md文件的项目。 下一步，我们在分支的存储库中扩展和改进自述文件（添加语法突出显示，修复格式设置等）。 然后，我们在克隆的存储库...
README-generator
03-28
该项目是一个免费的开源脚本，可以在命令行中运行。 它在gitbash中运行时效果最佳，并且需要一些命令行提示和降价知识。 如果您对编写自己的Markdown不太了解，我建议您在使用任何生成器（包括我的生成器）之前...
中文网页重设与排版typo.css.zip
07-18
├── README.md --- 使用帮助 ├── TODO.md --- TODO-List ├── license.txt --- 许可证 ├── typo.css --- 将应用于你的项目 └── typo.html --- Demo/预览 二、TYPO.CSS 的设计和使用 建议看...
README文件模板-New.zip
05-24
内含小型项目和国际开源项目的README.md文件的模板，资源类型为.md文件，文件内容可根据需要自行更改。
开源bbs源码java-YuleDevResources:渔乐科技开发部门专用的培训资料
06-06
开源 bbs 源码 java YuleDevResources 开发部门专用培训资料, 请在阅读其它资料前首先通读本文. 提示: 直接在github上观看, 排版比较凌乱, 也不支持某些Markdown扩展语法. 建议git clone(或者下载zip)到本地, 使用...
Facturitas:程序-用于在mysql数据库中管理发票的web-php。-开源
05-12
它使用FPDF类生成发票的PDF，从而能够打印它们。 目前，它是用“垃圾”代码制... 这是我的第一个开源项目，所以我不知道它是如何工作的。 我希望学习。 有关安装说明，请参阅readme.txt文件（在“浏览所有文件”下）。
rustlings:让你习惯阅读和编写 Rust 代码的小练习-开源
07-21
这个项目包含一些小练习，让你习惯阅读和编写 Rust 代码。 这包括阅读和响应编译器消息！ 或者，对于第一次 Rust 学习者，还有其他一些资源，比如 The Book，这是学习 Rust 的最全面的资源，但有时有点理论性。 您将...
毕业设计在线答题源码-International-Students-Web-Service:学生ITESM项目，用于跟踪学生表现的交换计划
06-06
毕业设计在线答题源码国际学生网络服务 一、总结 ...README.md # File with the project data (this file) - frontend # Frontend Solution (Web app) - backend # Backend Solution (CMS) - api
项目README文件的书写示例
xiaofiy的博客
12-14 6332
前言 一个优秀的项目，它的readme.md的文件肯定编写的特别规范，对用户 功能及体验 对开发者 可维护。如何书写一个好的readme文件呢，下文是以小程序 wepy框架开发的项目为例 ## 规范 一、 样式还原按设计稿 基准机型 100%还原，其他机型做适配 主题字体、颜色等设置全局变量 长度单位 rpx (不再设定变量转换) 二、内容及逻辑按需求文档(wiki) 三、命名及代码规范 英文语义化命名，示例：someName, some-name 属性、方法、变量名，小驼峰法，示
学习笔记：利用markdown写readme文档 （Udacity学城）
mini猿要成长QAQ
12-25 2910
周末逛知乎等资讯平台的时候，无意间了解到Udacity学城有一期关于利用markdown撰写readme文档的教程，想到CSDN博客也提供了markdown编辑功能，而自己到现在还不会用，看着自己写的丑陋的博客，决定趁此机会学习一下。于是乎，在学习过程中写了以下总结。以后可以用markdown写博客了，开心~Markdown 基础知识 设置文本加粗 设置文本斜体 码还是 不码 标题顺序 HTML 仍
如何确认github项目是否开源
05-01
如果是开源项目，那么参与者通过GitHub上的Pull Requests或Issues，可以提交反馈或提供代码改进的建议，因此你可以看到许多问题和请求。 确定Github项目是否开源可以确保你遵循许可证条款和条件，并可以计划关于该...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值