如何为开发项⽬编写规范的README⽂件（windows），此⽂详
解
为什么要写这篇博客？
  其实我是⼀个⼊坑已经半年的程序员，因为不是计算机专业，只能⾃⼰摸索，所以我深知博客的重要性。每次我的学习笔记啊，项⽬的，⾯试题啊，有的，只要有时间，我肯定上传上来，⼀⽅⾯⾃⼰可以随时随地的看，另⼀⽅⾯也可以⽅便⼤家。
  了解⼀个项⽬，恐怕⾸先都是通过其Readme⽂件了解信息。如果你以为Readme⽂件都是随便写写的那你就错了。github，oschina git gitcafe的代码托管平台上的项⽬的Readme.MD⽂件都是有其特有的语法的。称之为Markdown语法，今天要写的是关于README⽂件在windows中如何写，怎么写出来才符合要求，写出来才好看，这样就不得不说⼀下MarkDown编译器了。
  也许很多⼤神说，Markdown这么简单的，还需要写个博客炫耀？
  其实你错了，对于我们这些在windows上操作惯了的野路⼦，根本对除了word之外的编辑语⾔不感冒，也不习惯，但是每次项⽬都会需要README⽂件，记得我第⼀次写的README⽂件是TXT格式，被⽼师嘲笑了，说README⽂件是.md格式，但是我⾃⼰⽐较笨，请教了⼀个哥们，终于知道了写README的好
⽅法，那就是使⽤mardkdown⼯具，我下载的是有道云笔记（我还⽤的是windows操作系统），他不但有MARKDOWN，更重要的是，还有MarkDown使⽤指南，（⼤家不要误会，我不是推销这个软件，对于还是⼩⽩的我，觉得遇到了神器，很激动）。既然有这个了，那么我的问题就迎刃⽽解了。
  这篇⽂说到这⾥，这才刚刚开始，下⾯主要介绍⼀下 MarkDown的主要⽤法，⽅便⼤家写README⽂件。
为什么要写README⽂件？
  对于这个问题详解，请看博客：
  这个问题很简单，因为README的编写，过了很长时间后，你仍然知道你当初写了什么；因为README的编写，其他⼈看你的代码不需要那么费劲；因为README的编写，你代码的质量就⼤⼤的提⾼；因为README的编写，你的语⾔⽔平就⼤⼤的提⾼了。
  所以说README应该简短，⼤家不要以为写这个很⿇烦，这个东西能够节省你和别⼈的很多时间。
完整的README包括什么内容？
  关于README的内容，这是我觉得是每个项⽬中都应该有的⼀个⽂件，⽬的是能简要的描述该项⽬的信息，让读者快速了解这个项⽬。
怎么写代码做软件
⼀，它需要说以下⼏个事项：
1，软件定位，软件的基本功能
2，运⾏代码的⽅法：安装环境，启动命令等
3，简要的使⽤说明
4，代码⽬录结构说明，更详细点可以说明软件的基本原理
5，常见问题说明
⼆，它包括了⼀下内容：
项⽬和所有⼦模块和库的名称（对于新⽤户，有时不同命名会导致混乱）
对所有项⽬，和所有⼦模块和库的描述
如何使⽤ 5-line code（如果是⼀个库）
版权和许可信息（或阅读许可证）
抓取⽂档指令
安装、配置和运⾏程序的指导
抓取最新代码和构建它们的说明（或快速概述和「阅读 Install」）
作者列表或「Read AUTHORS」
提交bug，功能要求，提交补丁，加⼊邮件列表，得到通知，或加⼊⽤户或开发开发区的介绍
其他联系信息（电⼦邮件地址，⽹站，公司名称，地址等）
⼀个简短的历史记录（更改，替换或者其他）
法律声明
3，⼀个简单的范本（当然，我们前期写的话，不必要那么⿇烦，就写⼏个简单的必要的东西，⽐如法律声明啊，联系记录啊等等，就不必要写）
DEMO
===========================
>>#环境依赖
node v0.10.28+
redIs ~
>>#部署步骤
1. 添加系统环境变量
export $PORTAL_VERSION="production"// production, test, dev
2. npm install  //安装node运⾏环境
3. gulp build  //前端编译
4. 启动两个配置(已forever为例)
eg: forever start app-service.js
forever start logger-service.js
>>#⽬录结构描述
├── Readme.md                  // help
├── app                        // 应⽤
├── config                      // 配置
│├──default.json
│├── dev.json                // 开发环境
│├── experiment.json        // 实验
│├── index.js                // 配置控制
│├── local.json              // 本地
│├── production.json        // ⽣产环境
│└── test.json              // 测试环境
├── data
├── doc                        // ⽂档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js          // 启动⽇志配置
├── node_modules
├── package.json
├── app-service.js              // 启动应⽤配置
├──static// web静态资源加载
│└── initjson
│└── config.js        // 提供给前端的配置
├── test
├── test-service.js
└── tools
>>#V1.0.0版本内容更新
1. 新功能    aaaaaaaaa
2. 新功能    bbbbbbbbb
3. 新功能    ccccccccc
4. 新功能    ddddddddd
规范的README⽂件怎么写？
  上⾯介绍了README写的必要性和格式，那么核⼼问题来了，README 怎么写？
  前⾯我也提到了，对于常⽤windows的同学们，怎么写README呢？下⾯就说MarkDown了，可能⼀开始⼤家都不习惯，因为word,txt 等⽤的多了，现在还要⾃⼰加标题，加粗，等等。
  但是没办法啊，其实⼤家也不需要担⼼，MarkDown语法⾮常简单，⽽且实⽤，不到半个⼩时，你就全掌握了，所以呢，要是记不下，可以收藏⼩编这篇博客。
什么是Markdown语⾔?
  Markdown是⼀种轻量级的「标记语⾔」，通常为程序员体所⽤，⽬前它已是全球最⼤的技术分享⽹站 GitHub 和技术问答⽹
站 StackOverFlow 的御⽤书写格式。
  当然，我们这些程序员最喜欢了，因为Markdown的语法⼗分简单，常⽤的标记符号不超过⼗个，⽤于⽇常写作记录绰绰有余，不到半⼩时就能完全掌握。就是这⼗个不到的标记符号，却能让⼈优雅地沉浸式记录，专注内容⽽不是纠结排版，达到「⼼中⽆尘，码字⼊神」的境界。
利⽤MarkDown可以做什么？
1，代码⾼亮
2，制作代办事项To-do List
3，⾼效绘制流程图，序列图，⽢特图，表格
3-1流程图
3-2 序列图
3-3 ⽢特图
3-4，表格
4，书写数学公式
MarkDown的语法是什么呢？
  markdown的语法⾮常简单，常见的标记符合不超过10个，⽤于⽇常写作记录绰绰有余，不到半个⼩时就能完全掌握。
1，标题
  标题是每篇⽂章必备⽽且最常⽤的格式。
  在Markdown中，如果想将⼀段⽂字定义为标题，只需要在这段⽂字前⾯加上 #，再在 # 后加⼀个空格即可。还可增加⼆、三、四、五、六级标题，总共六级，只需要增加 # ，增加⼀个 # ，标题字号相应降低⼀级。如图：
2，列表
  列表格式也很常⽤，它可以让你的⽂稿变得井井有条。在 Markdown 中，你只需要在⽂字前⾯加上 - 就可以了；如果你希望是有序列表，在⽂字前⾯加上 1. 2. 3. 即可。
  注：-、1.和⽂字之间要保留⼀个字符的空格。
3，引⽤
  如果你需要在⽂稿中引⽤⼀段别处的句⼦，那么就要⽤到「引⽤」格式。
  在引⽤⽂字前加上 > 并与⽂字保留⼀个字符的空格，即可。
4，粗体和斜体
  Markdown 的粗体和斜体也⾮常简单：
  ⽤两个 * 包含⼀段⽂本就是粗体的语法；
  ⽤⼀个 * 包含⼀段⽂本就是斜体的语法。
5，链接与图⽚
  链接：在 Markdown 中，插⼊链接只需要使⽤ [显⽰⽂本](链接地址) 即可。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。

软件开发实习报告范文3篇
« 上一篇
如何成为优秀UI(交互界面)设计师
下一篇 »

发表评论

Copyright © 2024 baidu.com
Powered By 688IT编程网 豫ICP备2022007602号 豫公网安备41160202000602