原文:如何写一个优秀的GitHub项目README文档?

今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得 颗星星, Fork,相对而言,还是比较得到大家认可的。不花哨,不别出心裁,一个比较实用的,普适性的架子 所谓教科书式,不外如此。原文是英语,大神可直接看戳我查看。下面是我翻译的中文版 未完全按照原文翻译 ,献丑了。 项目名称 这里再写一句骚气又精准的话描述你的项目吧。 上手指南 写几句这样的话概括接下来的内容:以下指南 ...

2019-01-24 10:02 0 649 推荐指数:

查看详情

如何写一个通用的README规范

背景 我们平常在进行项目开发时,一般都会把代码上传至代码托管平台上方便管理和维护。目前我厂使用的托管平台是SVN,国内外还有一些比较知名的代码托管平台,比如github、Gitlab、BitBucket,码云和码市等。 但我们在多人合作开发下,经常碰到的最头疼的问题是,其他开发者 ...

Wed May 02 05:36:00 CST 2018 0 3806
github】论怎么去一个高大上的ReadMe

前言 以前我时常觉得,自己ReadMe很单调乏味,但后来仔细研究一下后,发现有很多方式可以让ReadMe在简洁的基础上变得好看些,所以在这里和大家分享,如果大家有更好的想法,也非常欢迎在评论区留言哦 美化方案 加彩色徽章:介绍npm版本,证书类型 ...

Mon Sep 09 16:02:00 CST 2019 9 942
小白如何写需求文档

,也不太适用于自己我们要做的OA. 既然是需求文档,那就应该根据项目实际情况去文档,所以我们在文档时注重 ...

Fri Jan 22 00:45:00 CST 2016 0 10133
如何写一份优秀的前端简历

前言 如今前端市场一片混乱,典型的金字塔形状,前端从业人员很多,但高级开发及以上却非常稀缺。前端招聘也是所有猎头及 HR 的痛点所在,在这种混乱的环境中,如何让自己突出重围?需要实力,也需要技巧。因 ...

Fri Jun 29 18:29:00 CST 2018 6 39938
php 如何写一个自己项目的安装程序

版权声明:此篇文章只是用作笔记,如果版权冲突,请邮件通知一下(15201155501@163.com) https://blog.csdn.net/shenpengchao/article/details/56678266 php的项目做完之后,一般都是预留出来配置文件 ...

Fri Mar 08 18:47:00 CST 2019 0 777
如何写md格式的文档

一、标题 标题其实和HTML中的h系列很像,想要设置为标题的文字前面加#来表示一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。 注:标准语法一般在#后跟个空格再写文字, 示例: 效果如下: 这是一级标题 这是二级标题 这是三级标题 这是四级标题 这是 ...

Tue Oct 15 19:17:00 CST 2019 0 420
github优秀开源项目

这里放置几个github优秀开源项目连接,以备查看: 1、https://github.com/Snailclimb/JavaGuide java面试指引 2、https://github.com/doocs/advanced-java  互联网java工程师进阶扫盲 ...

Mon Jun 10 18:44:00 CST 2019 0 872
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM