Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Multirious committed Jan 6, 2024
1 parent 8ae54a8 commit feefd54
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,27 @@ CLI too to run Helix in Window as an editor for mostly Godot but might work with

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


# Why not shell scripting?

I've tried, and it sucks.
The longer I use Window the more reason I got to move to Linux.


# Features

- It can switch tab.
- Something about making your (or just my) life easier.
- Just see the gif. I'm too lazy to explain these stuffs

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


# How to use

I'm lazy. I will write this section if this thing actually gets traction.
Run `-h`, `--help` to see availiable flags to use.
Mose features are explained in the help command.

See [Examples](#examples) section.

## Addtional notes
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.

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

# Examples

Godot config:
| Property | Value |
|---------- |------------------|
|`exec_path` |`helix-win-runner`|
|`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}`|
|`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 comments on commit feefd54

Please sign in to comment.