diff --git a/README.ch.md b/README.ch.md index f40862e..fa46d06 100644 --- a/README.ch.md +++ b/README.ch.md @@ -6,7 +6,7 @@ [English](./README.md) | [简体中文](./README.ch.md) -这是一个 [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) 的子插件, 提供了 `xvlog`/`xvhdl` 的接口. `xvlog`/`xvhdl` 由 [Vivado Simulator](https://www.xilinx.com/support/documentation-navigation/design-hubs/dh0010-vivado-simulation-hub.html) (XSim) 提供. `xvlog` 被用于 "Verilog" 和 "SystemVerilog" 文件 , `xvhdl` 被用于 "VHDL" 文件. +这是一个 [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) 的子插件, 提供了 `xvlog`/`xvhdl` 的接口. `xvlog`/`xvhdl` 由 [Vivado Simulator](https://www.xilinx.com/support/documentation-navigation/design-hubs/dh0010-vivado-simulation-hub.html) (XSim) 提供. `xvlog` 被用于 "Verilog" 和 "SystemVerilog" 文件, `xvhdl` 被用于 "VHDL" 文件. ## 安装 @@ -94,7 +94,7 @@ Sublime 不支持 Verilog/SystemVerilog/VHDL 语法高亮. - 更多选项请查看 [UG900](https://www.xilinx.com/support/documentation-navigation/design-hubs/dh0010-vivado-simulation-hub.html), 或在命令行中使用 `xvlog/xvhdl --help`. - `work_dir` 为 `xvlog/xvhdl` 的运行目录 - - 由于运行目录下会生成 `.dir` `.log` `.pb` 等目录或文件, 故上述参考设置中将其优先设为 `$TEMP`, 即操作系统临时文件夹, 当 `TEMP` 不存在时 (对于 Windows, 这是系统自带的环境变量), 才会依次选择后续目录. + - 由于运行目录下会生成 `.dir` `.log` `.pb` 等目录或文件, 故上述参考设置中将其优先设为 `$TEMP`, 即操作系统临时文件夹, 当 `$TEMP` 不存在时才会依次选择后续目录. 对于 Windows 用户,临时文件夹 `$TEMP` (即 `%TEMP%`) 已经存在并指向 `C:/Windows/Temp`. 对于 Linux 用户, `$TEMP` 需要手动配置或使用 `$XDG_RUNTIME_DIR` directory ([XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)) 替代, 可参考 stack exchange 上的[这个回答](https://superuser.com/questions/332610/where-is-the-temporary-directory-in-linux>). ## 示例 diff --git a/README.md b/README.md index fa89d25..e940e5d 100644 --- a/README.md +++ b/README.md @@ -86,14 +86,12 @@ Arguments can be passed in a [linter settings](http://www.sublimelinter.com/en/s - Remarks - `xvlog_sv` is equal to `xvlog` with `--sv` command option on, which is specifically made for SystemVerilog files. - - `args` is command option passed to `xvlog/xvhdl` - `--relax`: Relax strict HDL language checking rules, which is default settting of Vivado. - `-i`: Specify directories to be searched for files included using Verilog `` `include``. Use `-i`|`--include` for each specified search directory - For more information please check [UG900](https://www.xilinx.com/support/documentation-navigation/design-hubs/dh0010-vivado-simulation-hub.html), or using `xvlog/xvhdl --help`. - - `work_dir` is working directory `xvlog/xvhdl` - - Since `.dir` `.log` `.pb` folders or files will be generated in working directory, so I set `$TEMP` (i.e. temporary directory in Operating System) as working directory, when `TEMP` is not exist, the following directory will be selected. + - Since `.dir` `.log` `.pb` folders or files will be generated in working directory, so I set `$TEMP` as working directory, when `$TEMP` doesn't exist, the following directory will be selected. For Windows Users, the temporary folder `$TEMP` (a.k.a `%TEMP%`) already exists and located at `C:/Windows/Temp`. For Linux Users, `$TEMP` should be manually set or use `$XDG_RUNTIME_DIR` directory ([XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)) instead, for more information please check . ## Demo