docs

ljacobsson · Aug 7, 2023 · c2451b0 · c2451b0
1 parent d669ade
commit c2451b0
Showing 1 changed file with 9 additions and 6 deletions.
diff --git a/docs/samp-local-dotnet.md b/docs/samp-local-dotnet.md
@@ -2,25 +2,24 @@
 
 ### Prerequisites:
 * Function runtime should be `dotnet6`
-* Function type has to be zip. Image functions are not supported.
-* Has to be a SAM project. CDK might come later.
+* Has to be a SAM project. CDK might be supported later.
 * It assumes a folder structure where the SAM template is in the root, next to the `samconfig.toml` file
 * The SAM template can be in either JSON or YAML format and can be called anything with a `json`, `yml`, `yaml` or `.template` extension
 * You need to have npm/node installed on your system.
 
 ### Supported IDEs
 Local debugging should work in any IDE, however `samp local --debug` automates launch config for the following IDEs:
 * VS Code
-* JetBrains Rider
 * Visual Studio
+* JetBrains Rider
 
 ### Get started
 1. Install `samp-cli`:
 ```bash
 $ npm install -g samp-cli
 ```
 2. cd to your .NET Lambda project root (make sure it has been deployed and that you're targeting a test environment. *Never* run this against a production environment!)
-3. Run `samp local --debug` and follow the prompts. This will create/append to `launch.json` and `tasks.json` in your `.vscode` folder with the necessary launch configuration. You only need to do this once per project.
+3. Run `samp local --debug` and follow the prompts. This will create the required IDE specific configuration files.
 4. Run `samp local` and leave it running. (see `samp local --help` for all options)
 5. Hit F5 (or start debugging via the dropdown menu)
 
@@ -29,8 +28,12 @@ When you're done debugging, kill the `samp local` process with Ctrl+C (⌘+C on
 
 ### Hot reloads and .NET
 
-Hot reloads work well with NodeJS, but the native .NEt support isn't quite there yet and it's due in .NET 7
+Hot reloads work well with NodeJS, but the native .NET support isn't quite there yet and it's due in .NET 7
 8. After every change to your function code you need to ensure that the `./.samp-out/dotnet.csproj` file is re-compiled. You can either:
   - Manually recompile using the command line `dotnet build ./samp-out/dotnet.csproj`
   - Add the `dotnet.csproj` file to your solution and recompile as part of your debug process
-9. Hit F5 (or start debugging from the UI)
+9. Hit F5 (or start debugging from the UI)
+
+
+### Acknowledgement
+Big thanks to [James Eastham](https://twitter.com/plantpowerjames) for all the help with the testing and configuration.