Skip to content

Commit feefd54

Browse files
committed
docs: update README.md
1 parent 8ae54a8 commit feefd54

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,27 @@ CLI too to run Helix in Window as an editor for mostly Godot but might work with
44

55
Note that this works through keyboard macros, so try not to move around while the script is processing.
66

7-
8-
# Why not shell scripting?
9-
10-
I've tried, and it sucks.
11-
The longer I use Window the more reason I got to move to Linux.
12-
13-
147
# Features
15-
16-
- It can switch tab.
17-
- Something about making your (or just my) life easier.
18-
- Just see the gif. I'm too lazy to explain these stuffs
198

209
![preview](https://user-images.githubusercontent.com/77918086/224227674-7baa9fc7-a26d-422e-8cd7-8919bd6c8e5c.gif)
2110

2211

2312
# How to use
2413

25-
I'm lazy. I will write this section if this thing actually gets traction.
14+
Run `-h`, `--help` to see availiable flags to use.
15+
Mose features are explained in the help command.
16+
17+
See [Examples](#examples) section.
18+
19+
## Addtional notes
20+
When using `-e`, `--execute-path` flag and your editor requires additional initialization, you might need to provide a path to some kind of script to intialize the editor properly.
2621

22+
Use `--list` flag to display windows currently opened. Use the information in here for `-n`, `--window-process-name` or `-t`, `--window-title`.
2723

2824
# Examples
2925

3026
Godot config:
3127
| Property | Value |
3228
|---------- |------------------|
3329
|`exec_path` |`helix-win-runner`|
34-
|`exec_flags`|`-e "C:\Users\Windows10\Desktop\helix_cmder.bat" -w 3 -t "cmd - hx" -n "ConEmu.exe" -p {project} -f {file} -l {line} -c {col}`|
30+
|`exec_flags`|`-r -e "C:\Users\Windows10\Desktop\helix_cmder.bat" -w 3 -t "cmd - hx" -n "ConEmu.exe" -p {project} -f {file} -l {line} -c {col}`|

0 commit comments

Comments
 (0)