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

Update readme

Browse Source
This commit is contained in:
Krzosa Karol
2023-01-23 12:34:36 +01:00
parent cff88988e2
commit a50dc473da
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -7,15 +7,10 @@ This package seeks to recreate that experience in Sublime Text but without
the buggy and slow Visual Studio, thanks to a much better debugger that is RemedyBG the buggy and slow Visual Studio, thanks to a much better debugger that is RemedyBG
and it's user API! and it's user API!
### Requirement You can but the debugger here:
Obviously you need to have remedybg:
* https://remedybg.itch.io/remedybg * https://remedybg.itch.io/remedybg
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.
### Install ### Install
``` ```
@@ -29,10 +24,14 @@ Optional:
* Add remedy_executable to your settings if remedybg is not on your path or has different name. * Add remedy_executable to your settings if remedybg is not on your path or has different name.
* Setup vcvarsall, Look at vcvarsall section in readme. * Setup vcvarsall, Look at vcvarsall section in readme.
### Remedy build system ### Build before debugging
Sadly Sublime doesn't allow for querying of currently chosen build system. 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 Neither does it allow for effective hook into the builtin ```build``` command
with custom arguments as such this package needs to emulate the ```build``` command.
To make it so that you can build before debugging you need to firstly change
```Remedy.sublime-settings``` secondly, 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: