krzosa/sublime_text_remedybg_plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme formatting

Browse Source
This commit is contained in:
Krzosa Karol
2023-01-22 11:58:43 +01:00
parent 7ae4d1405b
commit 025cd2b5e5
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -10,10 +10,11 @@ and it's user API!
### Requirement ### Requirement
Obviously you need to have remedybg: Obviously you need to have remedybg:
https://remedybg.itch.io/remedybg
It needs to be available in the PATH with name "remedybg.exe". Alternatively you * https://remedybg.itch.io/remedybg
can add "remedy_executable": "C:/path/to/remedy" to your settings.
It needs to be available in the PATH with name ```remedybg.exe```. Alternatively you
can add ```"remedy_executable": "C:/path/to/remedy"``` to your settings.
### Remedy build system ### Remedy build system
@@ -21,7 +22,7 @@ Sadly Sublime doesn't allow for querying of currently chosen build system.
To make it so that you can build before starting to debug you need to have To make it so that you can build before starting to debug you need to have
a project / project file. That project file needs a build system, if there a project / project file. That project file needs a build system, if there
is only one build system, everything is going to work. If there are more, is only one build system, everything is going to work. If there are more,
you will need to add a field called "remedy_build_system", here is an example: you will need to add a field called ```remedy_build_system```, here is an example:
``` ```
{ {
@@ -47,6 +48,7 @@ you will need to add a field called "remedy_build_system", here is an example:
Feature idea. By clicking using your middle mouse button you can issue most Feature idea. By clicking using your middle mouse button you can issue most
of the available debugger commands. of the available debugger commands.
* Debugger goes to the place you clicked on * Debugger goes to the place you clicked on
* The word you clicked is going to get added to watch window * The word you clicked is going to get added to watch window
* If the word you clicked on matches "rt"(run_to_cursor, "r"(run), "rr"(stop), "rrr"(restart) then it's going to delete that word in sublime and issue a debugger command. So far I have found it to be nice for code discovery kind of stuff with the mouse + keyboard workflow, you can bind this to the keyboard too though. The commands are easy to type using single hand. * If the word you clicked on matches "rt"(run_to_cursor, "r"(run), "rr"(stop), "rrr"(restart) then it's going to delete that word in sublime and issue a debugger command. So far I have found it to be nice for code discovery kind of stuff with the mouse + keyboard workflow, you can bind this to the keyboard too though. The commands are easy to type using single hand.