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,一经查实,立即删除!

相关文章

java sunjce,无法初始化类javax.crypto.SunJCE_b

我已经开发了一个Javaservlet应用程序,并且在我的开发PC上,一切正常,包括按计划使用SFTP通过端口8443等上的HTTPS并以适当的SSL证书通过PDF复制PDF。但是,当我尝试在实时服务器上运行该应用程序时,会收到错误消息。jav…

GitHub添加SSH keys报错Key is invalid. It must begin with 'ssh-ed25519', 'ssh-rsa', 'ssh-dss', 'ecdsa-sha

GitHub添加SSH keys报错Key is invalid. It must begin with ‘ssh-ed25519’, ‘ssh-rsa’, ‘ssh-dss’, ecdsa-sha 在GitHub上Add SSH key的时候报错:Key is invalid. It must begin with ‘ssh-ed25519’, ‘ssh-rsa’, ‘ssh-dss’, ecdsa-sha。。。&#xff…

System.Diagnostics.Process 执行.EXE

分类: C#WINFORM 2009-04-05 21:09 459人阅读 评论(0) 收藏 举报 我们经常会遇到在Winform或是WPF中点击链接或按钮打开某个指定的网址, 或者是需要打开电脑中某个指定的硬盘分区及文件夹, 甚至是"控制面板"相关的东西, 那么如何做呢? 答案是使用Sys…

php 扩展 返回字符串,基于PHP7的PHP扩展开发之四(字符串的处理)

目的:熟悉字符串在PHP扩展里面如何处理要实现的PHP代码如下:1、当字符串不包含指定前缀字符串时,把前缀字符串和被检测字符合并返回。2、当字符串包含指定前缀字符串时,原样返回。 我们将使用PHP扩展的方式实现str_concat功能。fu…

对象之int介绍

#Auther Bob #--*--conding:utf-8 --*-- #创建两个int的对象&#xff0c;age1和age2age1 10 age2 int(1)#查看对象的类print(type(age1))# <class int>print(type(age2))# <class int> #bit_length表示一个十进制数最少需要占用多个二进制位print(age1.bit_lengt…

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

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

OpenStack 之vmware机器迁移到openstack集群

原理 openstack本身是支持使用vmware格式的镜像的&#xff0c;但是是需要我们我们在/etc/nova/nova.conf的配置文件中指定该计算节点使用vmware的驱动 123456789101112# Driver to use for controlling virtualization. Options# include: libvirt.LibvirtDriver, xenapi.XenAP…

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

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

Weblogic的管理服务器与受管服务器

weblogic管理服务器和受管服务器&#xff1a; 域包含一个称为“管理服务器”的特殊 WebLogic Server 实例&#xff0c;它是您配置和管理域中所有资源的中心点&#xff0c;一个域有仅只有一个管理服务器实例。 在生产环境中&#xff0c;应将 Web 应用程序、EJB 和其他资源部…

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

这是我想出的解决方案。谢谢mprat的帮助。在我发现spectralcolormap最适合这种任务&#xff0c;而且我还添加了您可以指定的边框。在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中&#xff0c;所有的请求最终都会到达某个Controller中的某个Action并由该Action负责具体的处理和响应。为了能够正确处理请求&#xff0c;Action的参数&#xff08;如果有的话&#xff09;&#xff0c;必须在Action执行之前&#xff0c;根据相…

Day07-函数(2)

1.函数类型 函数也是一种类型&#xff0c;我们自定义的函数就是函数对象&#xff0c;函数名保存了函数对象的引用&#xff08;地址&#xff09; def test():print(我是测试函数) ​ print(test) #函数名是变量&#xff0c;指向了函数对象 pf test #pf变量也指向了函数对…

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

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

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

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

yaml 解决问题

yaml 是什么&#xff1f; 在 github 一些开源项目里经常可以看到 .travis.yml 文件&#xff0c;后来接触持续集成这个概念时发现很多文件都是 .yml 后缀的文件。我在 阮一峰-YAML 语言教程 里了解了它的作用以及基本写法&#xff0c;他的那篇文章描述的略微有点啰嗦&#xff0…

2016 7 25 链表

1 #include<stdio.h>2 #include<stdlib.h>3 /* 4 usingnamespacestd;5 6 structNode7 {8 int data;//数据域9 struct Node*next;//指针域10 };11 12 /*13 Create14 *函数功能&#xff1a;创建链表.15 *输入&#xff1a;各节点的data16 *返回值&#xff1a;指…

php数值操作,php数值计算num类简单操作示例

php数值计算num类简单操作示例,在线,计算器,小数,整数,程序设计php数值计算num类简单操作示例易采站长站&#xff0c;站长之家为您整理了php数值计算num类简单操作示例的相关内容。本文实例讲述了php数值计算num类简单操作。分享给大家供大家参考&#xff0c;具体如下&#xff…

YAML-学习笔记!

YAML学习笔记 一、YAML简介 YAML&#xff0c;即YAML Ain’t Markup Language的缩写&#xff0c;YAML 是一种简洁的非标记语言。YAML以数据为中心&#xff0c;使用空白&#xff0c;缩进&#xff0c;分行组织数据&#xff0c;从而使得表示更加简洁易读。 二、YAML语法 1、基本规…

CentOS远程监控

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