Merge branch 'dev/doc'

Author: xsro

CHANGELOG.md

@@ -1,18 +1,26 @@
 # Change Log 更新日志
 
-[email](mailto:xsro@foxmail.com)|[issue](https://github.com/dosasm/masm-tasm/issues)
+[email](mailto:xsro@foxmail.com?subject=VSCode_Extension(xsro.masm-tasm)_report&body=hello)|[issue](https://github.com/dosasm/masm-tasm/issues)
 
 ## 1.0 Web Extension Support 浏览器端支持
 
+![web extension Demo](pics/demo_web-russiacube.gif)
+
 To keep the extension simple, I split the part of interaction with DOS emulator to a new 
 platform-specified extension [xsro.vscode-dosbox][vscode-dosbox]
 
 - add support for browser, you can use this extension in sites like [vscode.dev][vscode-dev] and [github-dev][github-dev]
 - add support for DOS emulator [DOSBox-x][dosbox-x]
 - change default emulator to jsdos
-- now only support single file DOS assembly, I try to add some multi-file assembly support, but is's confusing for me.
+- now **only** support single file DOS assembly, I try to add some multi-file assembly support, but is's confusing for me.
 - remove the capture of warning message
 - remove command `DOSBox here`
+- 1.0.1 patch
+  - fix #31 #32: improve **document format** 
+    - thanks to [BillLee-CN][BillLee-CN], [x402][x402]
+  - fix #32: use a TDConfig when debugging with TD for better experience.
+    - thanks to [x402][x402]
+  - (vscode-DOSBox) fix the error of update dosbox config
 
 为了保持简洁，我将与DOS模拟器交互的部分独立为一个新的插件[xsro.vscode-dosbox][vscode-dosbox]
 
@@ -22,13 +30,17 @@ platform-specified extension [xsro.vscode-dosbox][vscode-dosbox]
 - 移除一些烦人的设置，目前只支持单文件的DOS环境下汇编
 - 移除对汇编成功但是有警告信息时显示的界面消息
 - 移除命令`DOSBox here`
+- 1.0.1
+  - 修复格式化中未完全替换原内容的问题
+  - 恢复原来版本中的TDConfig
+  - (vscode-dosbox) 修复注入DOSBox设置会出现的混乱
 
 [vscode-dosbox]: https://marketplace.visualstudio.com/items?itemName=xsro.vscode-dosbox "VSCode DOSBox"
 [dosbox-x]: https://www.dosbox-x.com "DOSBox-x"
-[github-dev]: https://github.dev
-[vscode-dev]: https://vscode.dev
-
----
+[github-dev]: https://github.dev/dosasm/dos-assembly-codes "open sample code with github.dev"
+[vscode-dev]: https://vscode.dev/github/dosasm/dos-assembly-codes "open sample code with vscode.dev"
+[x402]: https://github.com/x402
+[BillLee-CN]: https://github.com/BillLee-CN
 
 ## 0.9.0
 

README.md

@@ -42,6 +42,7 @@ when you are editing `assembly` files ,you can right click at the editor panel,t
 
 - If your code just in a single file, set configuration `masmtasm.ASM.mode` as `single file`. The extension will copy your file to a seperate space in your machine to keep your workspace Folder clean.
 - If your project is complex and making up with many files, you may set configuration `masmtasm.ASM.mode` as `workspace` and keep your files' names follow the emulator's limitation.
+  - take `include <filename>` for example, the `<filename>` should be the relative path to your workspace Folder
 - Obviously, this extension may be not suitable for complex project
 
 ## Platform Support

README.zh.md

@@ -42,7 +42,7 @@
 ## 平台支持
 
 插件依赖[vscode-dosbox](https://marketplace.visualstudio.com/items?itemName=xsro.vscode-dosbox) 来与 DOS 模拟器交互。
-`vscode-dosbox`打包了 win 平台上的二进制文件，参考[它的文档](https://github.com/dosasm/vscode-dosbox#dependency-installation) 在其他平台安装相关 DOS 模拟器。
+`vscode-dosbox`打包了 win 平台上的二进制文件，参考[它的文档](https://github.com/dosasm/vscode-dosbox/blob/main/README.zh.md#安装依赖) 在其他平台安装相关 DOS 模拟器。
 
 ## 自定义 Actions
 

doc/develop.md

@@ -1,52 +1,40 @@
 # Develop
 
-## Requirement
+## STEPS
 
 ### 0.use GIT to clone this repository
 
-```bash
-cd myFolder
+```sh
+#cd myFolder
 git clone https://github.com/dosasm/masm-tasm.git
 ```
 
-### 1.install nodejs and npm
+### 1.install nodejs and npm and yarn
 
 the website of nodejs: <http://nodejs.org>, <http://nodejs.cn/>
 
-```bash
+```sh
 sudo apt install nodejs
 sudo apt install npm
+npm install --global yarn
 ```
 
-<details>
-<summary>use CNPM</summary>
-
-可以使用[CNPM](<https://developer.aliyun.com/mirror/NPM?from=tnpm>)来安装npm包
-
-```bash
-# 使用alias来使用cnpm：
-alias cnpm="npm --registry=https://registry.npm.taobao.org --cache=$HOME/.npm/.cache/cnpm --disturl=https://npm.taobao.org/dist --userconfig=$HOME/.cnpmrc"
-# 使用npm安装cnpm：
-sudo npm install -g cnpm --registry=https://registry.npm.taobao.org
-```
-
-</details>
-
 ### 2.install dependence
 
-```bash
-# install npm packages
-npm install #or use cnpm install
-# install for tool jsdos
-cd tools/js-dos && npm install && cd ../.. 
+```sh
+yarn install
 ```
 
 ### 3.generate `visx` package
 
-```bash
-npm run package
+```sh
+npx vsce package
 ```
 
 ### Debug
 
+```sh
+yarn watch
+```
+
 Press <kbd>F5</kbd> or Click `run` -> `Start Debugging`

pics/demo_web-russiacube.gif

@@ -3,4 +3,5 @@
 - folder `language`: provide Programmatic language features
 - folder `utils`: chore like i18n
 - folder `diagnose`: process the message of Assembler
-- folder `ASM`: codes for action with assembler and emulator
+- folder `ASM`: interface for interaction with assembler and emulator
+- folder `emulators`: codes for interaction with assembler and emulator