DuangDuangDuang!码云项目的 Readme.md 特殊技能

为什么80%的码农都做不了架构师?>>>   hot3.png

我们在 码云 上创建新项目的时候,常常会看到默认使用 README 文件初始化该项目(如图1 所示),然后在新建项目的根目录下就会生成一个 README.md 文件(如图2 所示)。

图1

图1 默认选中 README

图2

图2 生成 README 文件

那究竟什么是 README ?它有什么特殊的功能?我们要如何操作才能写出一个漂亮的 README 呢?

##一、什么是 README.md 文件 ?

一个合格的老司机想要在 码云 上了解一个项目,首先都会去翻看该项目的 README 文件,因为这个小小的静态文件其实传达了整个项目的概述,如项目的介绍、代码实现的功能、系统环境参数、部署要素等。

README 文件后缀名为 md,当然扩展名也可能是 txt ,rb 等。md 是 markdown 的缩写,是一种轻量级的「标记语言」。它用「标记」语法,来代替常见的字处理软件中大量的排版格式,从而让大家能够更专注于文字内容,是适合所有人的写作语言。

大家可以通过以下链接来进一步学习 markdown 的写作:

Markdown 语法说明

Markdown 在线工具

##二、如何玩转 码云 项目的 README.md?

码云 上创建 README.md 文件的时候,有一个关于文件内容显示优先级的小窍门分享给大家。

在如图2 所示的根目录下,再创建一个新文件 README.osc.md(或者 README-osc.md 或者 README_osc.md),大家会发现虽然在根目录下同时存在两个 README 文件,但项目页会优先显示含有 osc 的 README 文件中的内容。

图3

图3 README.md 文件中的内容

图4

图4 README.osc.md 文件中的内容

图5

图5 优先显示README.osc.md 内容

除此之外,当我们使用不同语言创建 README.md 文件时,系统会根据不同的命名规范来判断其显示的优先级,如下所示(优先级从左到右):

  • zh-CN 简体时:zh,cn,zh-cn,zh_cn;

  • zh-TW 繁体时:zh-hk,zh-tw,zh-yue,zh_hk,zh_tw,zh_yue;

  • en 英文时:en;

##三、README.md 常规模板

如果 README 包括下面的内容,那么当使用者打开项目,浏览 README 后,基本就知道该如何下手了。

  • 项目简介
  • 功能特性
  • 环境依赖
  • 部署步骤
  • 目录结构描述
  • 版本内容更新
  • 声明
  • 协议

当然这不是一个绝对的模板,但是其中有些必要的元素(如项目的介绍,使用,部署及目录结构)还是需要列出来。

如果你也了解 码云 项目 README 的小窍门,欢迎留言勾搭,分享。如果你还没有使用过 码云 的话,也欢迎来试试手~

转载于:https://my.oschina.net/gitosc/blog/846723

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/457129.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Unchecked runtime.lastError: Could not establish connection. Receiving end does not exist.

谷歌浏览器报错 版本 73.0.3683.103(正式版本) (32 位)报错内容如下Unchecked runtime.lastError: Could not establish connection. Receiving end does not exist.jquery.js:2 Cross-Origin Read Blocking (CORB) blocked cros…

解决Django静态文件配置pycharm高光问题

就困扰了我半天的Django静态文件配置问题 更改了setting 文件后 文件参考问题总会高亮让然觉得又错误怪怪的 所以索性直接眼不见心不烦 具体操作如下图: 就这样就可以啦 大功告成! 也顺便提一下静态文件配置问题: Django静态加载的设置…

python神经网络可视化,python中的神经网络感受野可视化

这是我想出的解决方案。谢谢mprat的帮助。在我发现spectralcolormap最适合这种任务,而且我还添加了您可以指定的边框。在from matplotlib import pyplotimport numpy as npborder 2images_amount 300row_amount 10col_amount 30image_height 28image_width 28…

Qt 多媒体音频模拟按钮发音(音视频启动)

## 项目演示 平台:windows或者ubuntu 要求:平台需要支持音频播放功能 文件格式:.wav 可以使用剪映生成,音频部分,我这里是简短的音乐 # Qt 多媒体简介 Qt QSound是Qt框架中的一个类,用于播放音频文件。它可以在Qt应用程序中实现简单的音频播放功能,包括播放、暂停和…

ASP.NET MVC5 ModelBinder

什么是ModelBinding ASP.NET MVC中,所有的请求最终都会到达某个Controller中的某个Action并由该Action负责具体的处理和响应。为了能够正确处理请求,Action的参数(如果有的话),必须在Action执行之前,根据相…

php在html里面的位置,关于script在html中的摆放位置解析

以前一直觉得script在html中的任何位置都可以,今天做一个需求的时候才更正了自己的错误思想啊--script的位置也不是随便放的。本文主要谈论关于script在html中的摆放位置。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。希望能帮助到…

Protocol Buffer技术详解(C++实例)

原文:http://www.cnblogs.com/stephen-liu74/archive/2013/01/04/2842533.html 这篇Blog仍然是以Google的官方文档为主线,代码实例则完全取自于我们正在开发的一个Demo项目,通过前一段时间的尝试,感觉这种结合的方式比较有利于培训…

CentOS远程监控

近日,因工作需要,学习了CentOS远程监控的水平有限,多指教。 远程访问CentOS,包括三种方式ssh,telnet,vnc。 本例涉及的是以vnc远程访问CentOS。指令在root下操作。注意:vnc的端口为5900&#xf…

BGP路由协议详解(完整篇)

原文链接:http://xuanbo.blog.51cto.com/499334/465596/ 2010-12-27 12:02:45 上个月我写一篇关于BGP协议的博文,曾许诺过要完善这个文档,但因最近的工作和授课很忙,所以没有时间进行完善。为了实现这个承诺,我在去外…

GitHub+Hexo搭建自己的Blog之-本地环境部署01

前言 之前我的博客没有绑自己的域名,一直在github上放着,访问起来比较麻烦,前阵子在阿里云买了这个域名,配置上之后,就可以通过自己的域名访问了,有些朋友问我这个博客怎么搭的,用的什么主题&am…

使用VS2010编译Qt 5.6.1过程记录

由于Qt官方发布的Qt 5.6.1二进制安装包没有对应VS2010版本的,而我的电脑上只安装了VS2010,因此只能自己编译。 本文记录本人的编译安装过程,以及其中遇到的一些问题。 本文使用VS2010 32位编译Qt 5.6.1。 1. 下载Qt源代码 Qt源代码下载地址&…

Windows安装Apache注册服务出现(OS 5)拒绝访问。 : AH00369: Failed to open the Windows service manager,

windows安装Apache,注册服务出现“(OS 5)拒绝访问。 : AH00369: Failed to open the WinNT service manager..."错误 在安装Apache的时候,我下载的是zip格式,不是msi安装版,需要自己注册服务,才能在桌面任务栏里有…

算法与数据结构(三) 二叉树的遍历及其线索化(Swift版)

前面两篇博客介绍了线性表的顺序存储与链式存储以及对应的操作,并且还聊了栈与队列的相关内容。本篇博客我们就继续聊数据结构的相关东西,并且所涉及的相关Demo依然使用面向对象语言Swift来表示。本篇博客我们就来介绍树结构的一种:二叉树。在…

linux替换某个文件夹下所有文件,Linux 批量查找并替换文件夹下所有文件的内容...

1.批量查找某个目下文件的包含的内容cd etcgrep -rn "查找的内容" ./2.批量替换某个目下所有包含的文件的内容cd etcsed -i "s/查找的内容/替换后的内容/g" grep -rl "查找的内容" ./3.批量查找并替换任意文件夹下的文件内容。sed -i "s/要…

java中String相等问题

判断两个字符串是否相等的问题。在编程中,通常比较两个字符串是否相同的表达式是“”,但在java中不能这么写。在java中,用的是equals(); 例:A字符串和B和字符串比较: if(A.equals(B)){ } 返回true 或false. String 的equals 方法用于比较两个…

WebForm 分页与组合查询

1.封装实体类 2.写查询方法 //SubjectData类 public List<Subject> Select(string name){List<Subject> list new List<Subject>();cmd.CommandText "select *from Subject where SubjectName like a ";cmd.Parameters.Clear();cmd.Parameters.A…

node.js简单爬虫

这里假设你已经安装好node.js和npm&#xff0c;如果没有安装&#xff0c;请参阅其他教程安装。 配置首先是来配置package.json文件&#xff0c;这里使用express,request和cheerio。package.json如下&#xff1a; {"name": "node-scrape","version&quo…

Struts2入门(二)——配置拦截器

一、前言 之前便了解过&#xff0c;Struts 2的核心控制器是一个Filter过滤器&#xff0c;负责拦截所有的用户请求&#xff0c;当用户请求发送过来时&#xff0c;会去检测struts.xml是否存在这个action&#xff0c;如果存在&#xff0c;服务器便会自动帮我们跳转到指定的处理类中…

linux固态机械分区吗,不再疑惑!实测数据后才知道固态硬盘究竟要不要分区

不再疑惑&#xff01;实测数据后才知道固态硬盘究竟要不要分区2019-12-10 20:52:00162点赞594收藏177评论前几年的固态硬盘价格昂贵&#xff0c;一般用户会选择128G或256G的固态作为系统盘&#xff0c;由于单盘空间不大&#xff0c;一般都会配合机械硬盘使用&#xff0c;无需考…

安卓手机的后门控制工具SPADE

SPADE&#xff0c;一款安卓手机的后门控制工具&#xff0c;安全研究人员可以以此了解和研究安卓后门原理。 首先&#xff0c;我们从网站www.apk4fun.com下载apk文件&#xff0c;如ccleaner。然后&#xff0c;我们安装spade git clone https://github.com/suraj-root/spade.git …