文档修改

Author: xsro

CHANGELOG.md

@@ -12,15 +12,19 @@ All notable changes to the "masm-tasm" extension will be documented in this file
 
 ### 0.1.5
 
+- [x] DOS 汇编基本的语法支持
+- [x] vscode 界面的大纲视图的简单实现
+
 汇编语言支持的symbol大概有以下几种，但是vscode的[SymbolKind](https://code.visualstudio.com/api/references/vscode-api#SymbolKind)却与它们不对应，我决定做以下对应
 
 |assembly symbol|vscode symbol|
 |---|---|
-|macro 宏|class|
-|segment段|module|
-|variable变量|variable|
-|label 标号|key|
-|procedure子程序|function|
+|macro|Module|
+|segment|Class|
+|procedure|Function|
+|struct|Struct|
+|label|Key|
+|variable|Variable|
 
 ### 0.1.4
 

README.md

@@ -1,24 +1,23 @@
-# Dos assembly (MASM/TASM) via DOSBox(and msdos-player)
+# DOS assembly (MASM/TASM) via DOSBox(and msdos-player)
 
 [中文](https://github.com/xsro/masm-tasm/blob/master/doc/README_zh.md)
 
-Language support for DOS assembly,very likely for you to study MASM, TASM and also the course <*principles& peripheral technology of microprocessor*>.()
+Language support for DOS assembly,suitable for studying MASM/TASM and the course <*principles& peripheral technology of microprocessor*>.
 
-- Support both **TASM and MASM**: you can choose MASM or TASM in the preference
-- **Editor Menu**: run and debug with right click on the VSCode editor panel
-- **Convenient**: related tools packaged in the extension. Just install and right click (recommand to use this ext in windows otherwise you should install dosbox first)
-- **Diagnose**: process the output of ASM tools and ouput them in **VSCode
-- **Hover**:show information of where the curser is 
-- Welcome [issue](https://github.com/xsro/masm-tasm/issues) and PR to build a better extension with your help.
-- Some interesting code your may need:[masm-tasm wiki](https://github.com/xsro/masm-tasm/wiki/dosbox)
+- Offer *grammar*,basic *outline* view and *hover* support for DOS assembly language
+- Support both **TASM and MASM** assembler tools: choose MASM or TASM in the preference
+- In **Editor Menu**: run and debug assembly with right click on the VSCode editor panel
+- **Convenient**: related tools packaged in the extension. Just install and right click
+- **Diagnose**: process the output of ASM tools and ouput them in VSCode
+- **Note**: Currently not support multi files assembly
 
-Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho) 's extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086) and [Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code). This extension now contribute an assembly language.
+Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho) 's extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086) and [Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code). Welcome [issue](https://github.com/xsro/masm-tasm/issues) and PR to build a better extension with your help.Here are some interesting code I use:[masm-tasm wiki](https://github.com/xsro/masm-tasm/wiki/dosbox)
 
 ## Features
 
-when your are editing `.asm(.ASM)` files ,you can right click at the editor panel,then you will see several choices listed below:
+when you are editing `assembly` files ,you can right click at the editor panel,then you will see several choices listed below:
 
-1. "Open dosbox": Open the dosbox. Copy current file to workspace as `D:\T.asm` in DOSBox. You can use command like `tasm T.asm` .[more info](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md)
+1. "Open dosbox": Open the dosbox, prepare the environment(copy file to dosbox's D:\ and add tools to path),[more info](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md)
 2. "Run ASM code": Compile and Run the program
 3. "Debug ASM code": Compile and Debug the program
 
@@ -40,12 +39,41 @@ your file will be copied as `D:\T.ASM` in DOSBox. (The extension will copy your
 
 ![diagnose](https://github.com/xsro/masm-tasm/raw/master/pics/demo_diagnose_tasm.gif)
 
+## Extension Settings
+
+for more,please see the `preference->settings`
+
+- `masmtasm.ASM.MASMorTASM` use `MASM` or `TASM` assembler in DOS emulator to run and debug assembly
+- `masmtasm.ASM.emulator` use dosbox or msdos-player as DOS emulator,defalut is DOSBox
+  - `DOSBox` more stable
+  - `msdos-player`quiet, it runs in command prompt(CMD).  So it cannot support GUI like `TD.exe`
+  - `auto` auto select
+    1. use msdos-player to compile and link
+    2. use DOSBox to run
+    3. use msdos-player for MASM(debug)
+    4. use DOSBox for TASM(TD)
+- `masmtasm.ASM.savefirst`  save file first before using
+- `masmtasm.ASM.toolspath` custom path of your ASM tools. [more info](#about-tools)
+- `masmtasm.dosbox.CustomResolution`: size(resolution) of the dosbox window,for example `1024x960`
+
+### About Tools
+
+The assembler MASM and TASM can only run in 16-bit environment. So the extension use DOSBox and MSDOS-player to emulate the 16-bit environment.
+the extension has built in tools for windows. But if you need to use assembler or emulator of different version. You can oragnize your tools follow the structure bellow and add the you folder's path to  `masmtasm.ASM.toolspath`
+
+- tools:your tools folder name, you can add the path of it to settings `masmtasm.ASM.toolspath`
+  1. `TASM`: TASM tools including `tasm.exe`,`tlink.exe`,`td.exe`
+  2. `MASM`: MASM tools including `masm.exe`,`link.exe`,`debug.exe`
+  3. `dosbox`: dosbox.exe and related files
+  4. `player`: msdos.exe
+
+Linux and other OS user do not need folder dosbox and player. Instead, we should make sure DOSBox can be opened by shell command `dosbox` (node: child_process.exec("dosbox"))
+
 ## Docs & Thanks & Licenses
 
 - this extension is [MIT license](https://github.com/xsro/masm-tasm/blob/master/LICENSE).
-  - thanks for [masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
-  - their [info and licences](https://github.com/xsro/masm-tasm/blob/master/doc/license_and_info.md)
-- [about the tools](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md)
+- thanks for [Roncho](https://marketplace.visualstudio.com/publishers/Roncho)'s [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086),[Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
+- [about the assembly and emulator tools](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md)
 - [some infomation :wiki](https://github.com/xsro/masm-tasm/wiki)
 
 Enjoy!:smile:

package.json

@@ -2,8 +2,8 @@
 	"name": "masm-tasm",
 	"displayName": "MASM/TASM",
 	"publisher": "xsro",
-	"description": "DOS汇编语言开发环境，自带DOSBox安装即用，支持TASM/MASM工具",
-	"version": "0.1.4",
+	"description": "DOS汇编语言开发环境和语法支持，安装即用,自带DOSBox.exe和TASM/MASM工具",
+	"version": "0.2.0",
 	"keywords":["dosbox","16位","汇编","微机原理","tasm","masm"],
 	"icon":"dosboxasm.png",
 	"engines": {