Merge pull request #4 from HonkW93/dev

Dev

Changelog.md

@@ -1,6 +1,35 @@
 # Changelog
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.1.6] - 2021-08-02
+
+### Added
+
+- Add `RtlTree`
+
+  新增`RtlTree()`，在原脚本（zhangguo）基础上进行如下改动
+
+  1. 新增`tags`内部集成，不再需要外部`ctag_gen`脚本即自动生成
+  2. 修复原脚本`:q`退出时无法再次进入的异常`Bug`
+  3. 实现跨文件夹`RtlTree`功能
+
+## [1.1.5] - 2021-08-01
+
+### Changed
+
+- Change configuration method for `AutoInst`, `AutoPara`, `AutoReg` & `AddHeader`
+
+  更改现有函数的配置方式，可通过`.vimrc`外部配置
+
+## [1.1.4] - 2021-07-21
+
+### Added
+
+- Add comment for `AutoInst`
+
+  `AutoInst()`可配置添加注释例化模块所在位置`//Instance...<DIR>...`
+
+
 ## [1.1.3] - 2021-06-21
 
 ### Fixed
@@ -36,7 +65,7 @@ All notable changes to this project will be documented in this file. The format
 
 - Optimize `GetIO`, `GetPara`, `DrawIO`, `DrawPara`, `DrawVaraValue`
 
-  优化写法，`GetIO()`, `GetPara()`, `DrawIO()`, `DrawPara()`, `DrawVaraValue()`等函数添加注释及折叠，方便后续定位故障
+  优化写法，`GetIO()`, `GetPara()`, `DrawIO()`, `DrawPara()`, `DrawParaValue()`等函数添加注释及折叠，方便后续定位故障
 
 
 
@@ -90,9 +119,9 @@ All notable changes to this project will be documented in this file. The format
 
 ## [1.0.7] - 2021-05-18
 ### Added
-- Add keep changed inst io name 
+- Add keep changed inst io name for  `AutoInst`
 
-  新增修改后的端口不重刷功能
+   `AutoInst()`新增修改后的端口不重刷功能
 
 
 

README.md

@@ -29,15 +29,31 @@
 
 一款基于Vimscript的自动化verilog脚本。由[automatic for Verilog & RtlTree](https://www.vim.org/scripts/script.php?script_id=4067)修改而来，原作者zhangguo。
 
-[![Release-Version](https://img.shields.io/badge/Release-1.1.3-blue.svg)](https://github.com/HonkW93/automatic-verilog/releases)-[![Vim-Version](https://img.shields.io/badge/Vim-7.4-green.svg)](https://www.vim.org/download.php)
+[![Release-Version](https://img.shields.io/badge/Release-1.1.6-blue.svg)](https://github.com/HonkW93/automatic-verilog/releases)-[![Vim-Version](https://img.shields.io/badge/Vim-7.4-green.svg)](https://www.vim.org/download.php)
 
-## 安装
+## 1. 安装
 
-将automatic.vim放入vim根目录下的plugin文件夹即可。
+### 1.1 简洁安装
+
+将`automatic.vim`放入`vim`根目录下的`plugin`文件夹即可。
+
+### 1.2  vim-plug
+
+```
+Plug 'HonkW93/automatic-verilog'
+```
+
+### 1.3  Vundle
+
+```
+Plugin 'HonkW93/automatic-verilog'
+```
 
 **提示：此脚本可能会修改文本数据，请在使用前备份数据，防止数据覆盖等情况发生。**
 
- ## 特性
+ ## 2. 特性
+
+### 2.1 自动化
 
 - 自动例化（`AutoInst`）
   - [x] 支持跨文件夹搜索.v文件进行例化，支持文件夹递归（参考`emacs verilog-mode`）
@@ -48,7 +64,6 @@
   - [x] 支持例化文件名与模块名不同的模块
   - [x] 支持配置为修改端口自动不重刷
   - [x] 支持`` `ifdef``及`` `endif``
-
 - 自动参数（`AutoPara`）
   - [x] 支持跨文件夹搜索.v文件进行例化，支持文件夹递归（参考`emacs verilog-mode`）
   - [x] 支持参数重刷（参考`emacs verilog-mode`）
@@ -58,7 +73,6 @@
   - [x] 支持配置为.A(A)或者.A(5)的写法
   - [x] 支持配置为修改过的参数自动不重刷
   - [x] 支持`` `ifdef``及`` `endif``
-
 - 自动reg（`AutoReg`）
   - [x] 支持端口`output reg`覆盖定义（参考`emacs verilog-mode`）
   - [ ] 支持`always`语句阻塞/非阻塞赋值`reg`获取（参考`vim automatic-verilog`）
@@ -71,35 +85,36 @@
     - [ ] 支持右端`en ? signal_b : signal_c[2:0]`写法
     - [ ] 支持右端`{}`写法
     - [ ] 进行中...
-
 - 自动wire（`AutoWire`）
   - [ ] 支持例化`inst_wire`自动获取
   - [ ] 支持`assign`语句`wire`自动获取
   - [ ] 进行中...
-
 - 自动定义（`AutoDef`） 
   - [ ] 支持`AutoWire`
   - [ ] 支持`AutoReg`
   - [ ] 进行中...
-
 - 自动接口（`AutoInterface`）
   - [ ] 梳理`sv`中`interface`的自动例化
   - [ ] 梳理中...
-
 - 其他（`Other`）
  - [ ] 梳理`emacs verilog-mode`中其他`auto`函数...
  - [ ] 梳理中...
 
-## 文档
+### 2.2 Rtl 树
+
+- 通过`RtlTree`浏览`Rtl`结构
+  - [x] 支持跨文件夹
+
+## 3. 文档
 
 [Vimcript-AutoMatic | HonkW](https://blog.honk.wang/posts/AutoMatic/)
 
 
-## 更新
+## 4. 更新
 
 [Update](/Changelog.md)
 
 
-## 开源协议
+## 5. 开源协议
 
 [GPL V3.0](/LICENSE)