编写项目开发的readme.md自述文件_MarkdownPad2与awesomium

一、使用的软件

1. MarkdownPad2 - 编写

–>MarkdownPad2官网下载传送门<–

2. awesomium - 实时预览（可另选用浏览器预览，非必须）（下载缓慢）

–>awesomium官网下载传送门<–

二、自述文件的结构

• 标题
• 项目简介
• 开发目的
• 环境依赖和相关软件
• 使用框架
• 部署步骤
• 目录结构描述
• 关于作者
• 更新日志

三、模板

##自用模板
readme.md自述结构
===========================

###项目简介
这是我的readme.md

###开发目的
便于编写readme.md

###环境依赖以及所需软件
1. MarkdownPad2
2. awesonium
3. Java 1.8+
4. IDEA 2019+

###使用框架
Maven - 依赖属性管理

###部署步骤
1.添加Java到系统环境变量
2.在IDEA配置Java
3.运行IDEA

###目录结构描述
<pre>
│  test.java             
└─ README.md
</pre>

###关于作者
CSDN   @东京没有下雨天
GitHub @HolaAsuka

###更新日志
暂无

四、说明

Ⅰ、目录结构描述获取

打开CMD转至所要描述的目录结构之下，运行代码tree /f > tree.txt获取

Ⅱ、MarkdownPad2更改设置

1、设置中文

MarkdowPad2 > Tools – Editor – Application Language > 中文

2、更改Markdown处理器

若不适应默认的处理语句，可更改匹配同Github
MarkdowPad2 > 工具 – Markdown – Markdown处理器 > Github风格
MarkdowPad2 > Tools – Markdown – Markdown Processor >Github风格

3、预览

实时预览需下载awesomium，可选择手动用浏览器预览

实时预览开关：F5
浏览器预览开关：F6

Ⅲ、Markdown基本语法

–>基本语法传送门<–

完

欢迎在评论区留言
感谢浏览