Skip to content

Commit 20b2f86

Browse files
committed
update doc and dependencies
1 parent b11162e commit 20b2f86

File tree

9 files changed

+186
-176
lines changed

9 files changed

+186
-176
lines changed

CHANGELOG.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
## welcome feedback and contribution [github issue](https://github.com/xsro/masm-tasm/issues)
44

5-
### 0.3.1
5+
### 0.4.0
66

7-
- [x] dosbox更新到0.74-3
8-
- [x] 修复Dosbox无法挂载带有中文的路径的问题[#5](https://github.com/xsro/masm-tasm/issues/5)
7+
- fix [#6](https://github.com/xsro/masm-tasm/issues/6): 修复打开单个汇编文件插件不激活的问题
8+
- 假如文件languageID是assembly,masm,tasm时插件会激活
9+
- 增加一个设置选项`masmtasm.language.Hover`以决定是否显示悬浮提示Hover
910

1011
### 0.3.0
1112

1213
- windows下打开dosbox会弹出控制台窗口,可以在设置`masmtasm.dosbox.console`中选择显示,最小化还是不显示这个窗口
14+
- (0.3.1)dosbox更新到0.74-3
15+
- (0.3.1)修复Dosbox无法挂载带有中文的路径的问题[#5](https://github.com/xsro/masm-tasm/issues/5)
1316

1417
### 0.2.2/0.2.3
1518

@@ -32,7 +35,7 @@ DEMO `dosbox here`:(代码来自[dpisdaniel/assembly-pacman](https://github.com/
3235
1. 打开命令面板,win下为`ctrl+shift+p`
3336
2. 在打开的dosbox窗口,输入汇编、链接、运行命令`tasm projf`,`tlink projf`,`projf`
3437

35-
![demo pacman](https://github.com/xsro/masm-tasm/raw/master/pics/demo_pacman.gif)
38+
![demo pacman](https://github.com/xsro/masm-tasm/raw/main/pics/demo_pacman.gif)
3639

3740
## 0.2.0
3841

README.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DOS assembly (MASM/TASM) via DOSBox(and msdos-player)
22

3-
[中文](https://github.com/xsro/masm-tasm/blob/master/doc/README_zh.md)|[English](https://github.com/xsro/masm-tasm/blob/master/README.md)
3+
[中文](https://github.com/xsro/masm-tasm/blob/main/doc/README_zh.md)|[English](https://github.com/xsro/masm-tasm/blob/main/README.md)
44

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

@@ -9,50 +9,50 @@ Language support for DOS assembly,may be suitable for studying MASM/TASM and the
99
- In **Editor Menu**: run and debug assembly with right click on the VSCode editor panel
1010
- **Diagnose**: process the output of ASM tools and display them in VSCode
1111
- **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 first
12+
- [For other systems](#for-linux): you need to install [DOSBox](https://www.dosbox.com) first
1313

1414
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.
1515

1616
## Features
1717

1818
when you are editing `assembly` files ,you can right click at the editor panel,then you will see several choices listed below:
1919

20-
1. "Open dosbox": Open the dosbox, prepare the environment(copy file to dosbox's D:\ and add tools to path)
21-
2. "Run ASM code": Compile and Run the program
22-
3. "Debug ASM code": Compile and Debug the program
20+
1. **Open dosbox**: Open the dosbox, prepare the environment(copy file to dosbox's D:\ and add tools to path)
21+
2. **Run ASM code**: Assemble,link and Run the program
22+
3. **Debug ASM code**: Assemble,link and Debug the program
2323

2424
## Demo
2525

2626
### Demo 1: Run and Debug Assembly
2727

28-
| using TASM via DOSBox | using MASM via msdos-player |
29-
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
30-
| ![demo dosbox tasm](https://github.com/xsro/masm-tasm/raw/master/pics/demo_dosbox_tasm.gif) | ![demo msdos-player masm](https://github.com/xsro/masm-tasm/raw/master/pics/demo_msdos_masm.gif) |
28+
| using TASM via DOSBox | using MASM via msdos-player |
29+
| ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
30+
| ![demo dosbox tasm](https://github.com/xsro/masm-tasm/raw/main/pics/demo_dosbox_tasm.gif) | ![demo msdos-player masm](https://github.com/xsro/masm-tasm/raw/main/pics/demo_msdos_masm.gif) |
3131

32-
When opened a ASM file in Editor, Right click on the Editor, then run or debug the code. Default mode is using `DOSBox` and `TASM`, you can change it in `preference->settings` like the second gif(using MASM via msdos-palyer).
32+
When opened a ASM file in Editor, Right click on the Editor, then run or debug the code. Default mode is using `DOSBox` and `TASM`, you can change them in `preference->settings` like the second gif(using MASM via msdos-palyer).
3333

3434
### Demo 2: code Formate,Diagnose and more
3535

36-
| Formate Codes | Diagnose |
37-
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
38-
| ![programmatic lanaguage features](https://github.com/xsro/masm-tasm/raw/master/pics/demo_PLFeature.gif) | ![diagnose](https://github.com/xsro/masm-tasm/raw/master/pics/demo_diagnose_tasm.gif) |
36+
| Formate Codes | Diagnose |
37+
| ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
38+
| ![programmatic lanaguage features](https://github.com/xsro/masm-tasm/raw/main/pics/demo_PLFeature.gif) | ![diagnose](https://github.com/xsro/masm-tasm/raw/main/pics/demo_diagnose_tasm.gif) |
3939

4040
The extension offer some programmatic features like "hover","formate","jump to definition",you can close them in the `preferece->settings`
4141

4242
### Demo 3: Open dosbox and type the command you need
4343

44-
| Single-File (command `Open DOSBox`) | Multi-Files (command `Dosbox here`) |
45-
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
46-
| ![Open in Dosbox](https://github.com/xsro/masm-tasm/raw/master/pics/opendosbox.gif) | [![pacman](https://github.com/xsro/masm-tasm/raw/master/pics/demo_pacman.gif)](https://github.com/dpisdaniel/assembly-pacman) |
44+
| Single-File (command `Open DOSBox`) | Multi-Files (command `Dosbox here`) |
45+
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
46+
| ![Open in Dosbox](https://github.com/xsro/masm-tasm/raw/main/pics/opendosbox.gif) | [![pacman](https://github.com/xsro/masm-tasm/raw/main/pics/demo_pacman.gif)](https://github.com/dpisdaniel/assembly-pacman) |
4747

48-
- some ASM commands you may need: [ASM_commands](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md).
49-
- Some interesting assembly codes you may need: [DOSBox ASM codes](https://github.com/xsro/masm-tasm/wiki/dosbox)
5048
- Command "`Open DOSBox`": Your file will be copied as `D:\T.ASM` in DOSBox. (The extension will copy your file to work space and mount this space to DOSbox disk `D:`)
51-
- Command "`Doxbox here`": The extension will mount your active editor's file to dosbox's disk `E:` and will not copy your file
49+
- Command "`Doxbox here`": The extension will mount your active editor file's folder directly to dosbox's disk `E:`.
50+
- some ASM commands you may need: [ASM_commands](https://github.com/xsro/masm-tasm/wiki/ASM_commands).
51+
- Some interesting assembly codes you may need: [DOSBox ASM codes](https://github.com/xsro/masm-tasm/wiki/dosbox)
5252

5353
## For linux
5454

55-
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
55+
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
5656

5757
```sh
5858
sudo apt install dosbox #install dosbox
@@ -63,23 +63,23 @@ dosbox #if successfully opened the dosbox, it is largely possible for the extens
6363

6464
for more,please see the `preference->settings`
6565

66-
- `masmtasm.ASM.MASMorTASM` use `MASM` or `TASM` assembler in DOS emulator to run and debug assembly
67-
- `masmtasm.ASM.emulator` use dosbox or msdos-player as DOS emulator,defalut is DOSBox
66+
- `masmtasm.ASM.MASMorTASM` use *MASM* or *TASM* assembler in DOS emulator to run and debug assembly
67+
- `masmtasm.ASM.emulator` use dosbox or msdos-player as DOS emulator
6868
- `DOSBox` (default) more stable
6969
- `msdos-player`quiet, it runs in command prompt(CMD). So it cannot support GUI like `TD.exe`
70-
- `auto` (recommand)auto select
70+
- `auto` auto select
7171
1. use msdos-player to compile and link
7272
2. use DOSBox to run
7373
3. use msdos-player for MASM(debug)
7474
4. use DOSBox for TASM(TD)
7575
- `masmtasm.ASM.savefirst` save file first before using
76-
- `masmtasm.ASM.toolspath` custom path of your ASM tools. [more info](#about-tools)
76+
- `masmtasm.dosbox.run`:what to do after run your code in DOSBox
7777
- `masmtasm.dosbox.CustomResolution`: size(resolution) of the dosbox window,for example `1024x960`
78+
- `masmtasm.ASM.toolspath` custom path of your ASM tools. [more info](#about-tools)
7879

7980
### About Tools
8081

81-
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.
82-
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 your folder's path to `masmtasm.ASM.toolspath`
82+
the extension has built in tools for windows. But if you need to use assembler or emulator of different version. You can organize your tools following the structure bellow and add your folder's path to `masmtasm.ASM.toolspath`, see [more info](https://github.com/xsro/masm-tasm/blob/main/doc/Toolspath.md)
8383

8484
- tools:your tools folder name, you can add the path of it to settings `masmtasm.ASM.toolspath`
8585
1. `TASM`: TASM tools including `tasm.exe`,`tlink.exe`,`td.exe`
@@ -101,9 +101,8 @@ The extension will mount some folder to DOSBox 's disk. Please don't modify them
101101

102102
## Docs & Thanks & Licenses
103103

104-
- This extension is [MIT license](https://github.com/xsro/masm-tasm/blob/master/LICENSE).
104+
- This extension is [MIT license](https://github.com/xsro/masm-tasm/blob/main/LICENSE).
105105
- 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)
106-
- [about the assembly and emulator tools](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md)
107106
- [some infomation :wiki](https://github.com/xsro/masm-tasm/wiki)
108107

109108
Enjoy!:smile:

doc/ASM_commands.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

doc/Get_start.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)