Skip to content

Commit 295452f

Browse files
committed
update docs for release 0.5.3
1 parent 85c10a4 commit 295452f

File tree

5 files changed

+30
-32
lines changed

5 files changed

+30
-32
lines changed

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Change Log
22

3-
## welcome feedback and contribution [github issue](https://github.com/xsro/masm-tasm/issues)
3+
## A VSCode Extension for learning DOS assembly(MASM/TASM) via DOSBox
44

5-
### 0.5.0/0.5.1/0.5.2
5+
## 0.5.x
66

77
- MASM插件更新到 `6.11`,最近在想如何支持`masm6.x`语法
88
- 尝试用异步重写了一些代码,希望不要引入bug
99
- (0.5.2)修复由于masm无法脱离ml运行而引发的问题
10-
- 如果仍然有问题,可以安装历史版本
10+
- (0.5.3)修复有些情况会调用错误的dos模拟器的问题
11+
- 如果仍然有问题,可以安装历史版本推荐`0.4.0`,`0.5.0-0.5.2`可能有致命问题不推荐
1112

1213
### 0.4.0
1314

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,11 @@
44

55
Language support for DOS assembly,may be suitable for studying MASM/TASM and the course <*principles& peripheral technology of microprocessor*>.
66

7-
- Offer *grammar*,basic *outline* view,*hover*,*code formate* support for DOS assembly language
8-
- Support both **TASM and MASM** assembler tools: you can choose MASM or TASM in the preference
9-
- In **Editor Menu**: run and debug assembly with right click on the VSCode editor panel
7+
- (**Language Support**) Offer *grammar*,basic *outline* view,*hover*,*code formate* support for DOS assembly language
8+
- **Run and debug** assembly with right click on the VSCode editor panel. You can choose using MASM or TASM in the preference-settings.
109
- **Diagnose**: process the output of ASM tools and display them in VSCode
1110
- **For windows**, all needed tools have been packaged in the extension.Just install and enjoy!
12-
- [For other systems](#for-linux): you need to install [DOSBox](https://www.dosbox.com) first
13-
14-
Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho) 's extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086),[blindtiger](https://github.com/9176324)'s [masm](https://github.com/9176324/bltg-team.masm) 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.
11+
- [For other systems](#for-other-system): you need to install [DOSBox](https://www.dosbox.com) first
1512

1613
## Features
1714

@@ -50,7 +47,7 @@ The extension offer some programmatic features like "hover","formate","jump to d
5047
- some ASM commands you may need: [ASM_commands](https://github.com/xsro/masm-tasm/wiki/ASM_commands).
5148
- Some interesting assembly codes you may need: [DOSBox ASM codes](https://github.com/xsro/masm-tasm/wiki/dosbox)
5249

53-
## For linux and other system
50+
## For other system
5451

5552
The extension is packaged with all needed [tools](#about-tools) inside,but some of these tools are for windows. So **Linux and other OS** users *should* make sure DOSBox can be opened by shell command `dosbox` (node: child_process.exec("dosbox")). Use command like
5653

@@ -101,8 +98,10 @@ The extension will mount some folder to DOSBox 's disk. Please don't modify them
10198

10299
## Docs & Thanks & Licenses
103100

104-
- This extension is [MIT license](https://github.com/xsro/masm-tasm/blob/main/LICENSE).
105-
- 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),[blindtiger](https://github.com/9176324)'s [masm](https://github.com/9176324/bltg-team.masm),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
101+
- Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho) 's extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086),[blindtiger](https://github.com/9176324)'s [masm](https://github.com/9176324/bltg-team.masm) for ASM language information
102+
- Thanks to [Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code)
103+
- Using [msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com) as DOS environment emulator
104+
- Welcome [issue](https://github.com/xsro/masm-tasm/issues) and PR to build a better extension with your help
106105
- [some infomation :wiki](https://github.com/xsro/masm-tasm/wiki)
107106

108107
Enjoy!:smile:

doc/README_zh.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,15 @@
44

55
:raising_hand:在学习《微型计算机原理与接口技术》的**汇编语言**部分时,苦于没有比较顺手的编程环境,此插件实现了在VSCode中对DOSBox等汇编工具的快速调用。主要功能特性如下:
66

7-
- 提供代码高亮,大纲信息,悬浮提示,代码格式化,错误信息标注功能
8-
- 同时支持调用**TASM****MASM**: 可以在设置(首选项)中修改使用MASM还是TASM工具集
9-
- 提供编辑器**右键菜单**选项:在汇编语言的编辑器添加了“打开dosbox,运行,调试”的三个选项
10-
- 提供diagnose**错误信息标注**功能:假如汇编未通过,会标明错误信息与位置,可以在命令面板输入`清除MASM/TASM的所有问题信息`清除本插件输出的diagnose问题信息
7+
-**语法支持**)代码高亮,大纲信息,悬浮提示,代码格式化,错误信息标注功能
8+
-**运行调试**)提供编辑器右键菜单选项:在汇编语言的编辑器添加了“打开dosbox,运行,调试”的三个选项
9+
- 提供diagnose**错误信息标注**功能:假如汇编未通过,会根据汇编器输出来标明错误信息与位置,可以在命令面板输入`清除MASM/TASM的所有问题信息`清除本插件输出的diagnose问题信息
1110
- 对于**windows**使用者,已将所需的工具打包在插件中,安装即用
1211
- [其他系统](#非windows使用者)的使用者需要先手动安装[DOSBox](https://www.dosbox.com)
1312

14-
非常感谢[Roncho](https://marketplace.visualstudio.com/publishers/Roncho)[Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086)[Woodykaixa](https://github.com/Woodykaixa)[masm-code](https://github.com/Woodykaixa/masm-code)[blindtiger](https://github.com/9176324)[masm](https://github.com/9176324/bltg-team.masm)等项目!插件难免会有一些bug,欢迎到github发[issue](https://github.com/xsro/masm-tasm/issues)以及PR,大家一起交流和完善。
15-
1613
## :wave:Features主要功能
1714

18-
当编辑器为汇编文件时,在编辑器界面右键菜单中会提供以下三个选项:
15+
当编辑器为汇编文件时,在编辑器界面右键菜单中会提供以下三个选项,插件会将编辑器当前文件复制到一个“相对安全”的位置作为`T.ASM`,此时DOSBox中的`D:\T.ASM`即为编辑器文件的副本。插件会根据`首选项-设置`中的设置,调用DOSBox或者msdos使用MASM/TASM来进行下列操作
1916

2017
1. 打开dosbox并配置环境(挂载):打开DOSBox,然后就可以手动在打开的DOSBox窗口输入指令进行操作
2118
2. 运行当前程序(汇编+链接+运行):生成exe程序并运行
@@ -33,7 +30,7 @@
3330

3431
### Demo 2: 代码格式化与错误输出
3532

36-
| Formate Codes | Diagnose |
33+
| 格式化代码 | 错误信息输出 |
3734
| -------------------------------------------------------------- | ---------------------------------------------- |
3835
| ![programmatic lanaguage features](../pics/demo_PLFeature.gif) | ![diagnose](../pics/demo_diagnose_tasm_zh.gif) |
3936

@@ -61,10 +58,9 @@ dosbox #打开dosbox,假如成功打开dosbox则安装成功,那么插件插
6158

6259
理论上说只要能在命令行执行`dosbox`命令打开dosbox(nodejs 的child_process.exec(dosbox)命令),就可以使用本插件。
6360

61+
## :point_right:Extension Settings主要拓展设置
6462

65-
## :point_right:Extension Settings拓展设置
66-
67-
要实现Demo中的功能有时会需要在拓展中进行设置,同时设置(首选项)中还有一些其他选项,以提供更大的灵活性。详见`首选项->设置`界面。
63+
详见`首选项->设置`界面,这里罗列一些可能比较重要的设置选项
6864

6965
- `masmtasm.ASM.MASMorTASM`:汇编工具使用`MASM`还是`TASM`
7066
- `masmtasm.ASM.emulator`:16位模拟器使用`dosbox`还是`msdos-player`
@@ -82,9 +78,12 @@ dosbox #打开dosbox,假如成功打开dosbox则安装成功,那么插件插
8278

8379
### :clap:文档 & 感谢 & 许可
8480

85-
- 感谢[masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
86-
- 他们的[相关信息](doc/license_and_info.md)
81+
- 该插件受[Woodykaixa](https://github.com/Woodykaixa)[masm-code](https://github.com/Woodykaixa/masm-code)启发
82+
- 非常感谢[Roncho](https://marketplace.visualstudio.com/publishers/Roncho)[Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086)中的汇编语法信息
83+
- 插件通过[msdos player](http://takeda-toshiya.my.coocan.jp/msdos)[dosbox](https://www.dosbox.com)模拟DOS环境
84+
- 一些[相关信息](doc/license_and_info.md)
8785
- 关于插件对汇编工具的使用:[Toolspath](./Toolspath.md)
8886
- 一些相关资料:[wiki](https://github.com/xsro/masm-tasm/wiki)
87+
- 插件难免会有一些bug,欢迎到github发[issue](https://github.com/xsro/masm-tasm/issues)或者邮件`xsro@foxmail.com`,一起交流和完善。
8988

9089
Enjoy!:smile:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"displayName": "MASM/TASM",
44
"publisher": "xsro",
55
"description": "DOS汇编语言开发环境和语法支持,win下安装即用,自带DOSBox.exe和TASM/MASM工具",
6-
"version": "0.5.3-beta.1",
6+
"version": "0.5.3",
77
"keywords": [
88
"dosbox",
99
"16位",

src/configration.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export class Config {
9090
);
9191
};
9292
//写dosbox配置信息
93-
this.writeBoxconfig(this);
93+
this.writeBoxconfig();
9494
}
9595
public get OpenDosbox() {
9696
//command for open
@@ -212,16 +212,15 @@ export class Config {
212212
}
213213
/**
214214
* write the DOSBox configuration file
215-
* @param conf
216215
* @param autoExec
217216
*/
218-
private writeBoxconfig(conf: Config, autoExec?: string) {
219-
let configUri = conf.dosboxconfuri;
217+
private writeBoxconfig(autoExec?: string) {
218+
let configUri = this.dosboxconfuri;
220219
let configContent = `[sdl]
221-
windowresolution=${conf.resolution}
220+
windowresolution=${this.resolution}
222221
output=opengl
223222
`;
224-
if (autoExec) { configContent = configContent + '\n' + autoExec; }
223+
if (autoExec) { configContent = configContent + '\n[AUTOEXEC]\n' + autoExec; }
225224
writefile(configUri, configContent);
226225
}
227226

0 commit comments

Comments
 (0)