Update readme and URLs (#350)

* Update URLs for repo name-change * Add instructions about enabling debugging in readme --------- Co-authored-by: cjsha <[email protected]> Co-authored-by: bparks13 <[email protected]> Co-authored-by: Jonathan Newman <[email protected]>
open-ephys · Oct 29, 2024 · 634a54c · 634a54c
1 parent 4d7d712
commit 634a54c
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 6 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -3,11 +3,11 @@
   <PropertyGroup>
     <Authors>Open Ephys</Authors>
     <Copyright>Copyright © Open Ephys and Contributors 2024</Copyright>
-    <PackageProjectUrl>https://open-ephys.github.io/onix1-bonsai-docs</PackageProjectUrl>
+    <PackageProjectUrl>https://open-ephys.github.io/bonsai-onix1-docs</PackageProjectUrl>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <IncludeSymbols>true</IncludeSymbols>
-    <RepositoryUrl>https://github.com/open-ephys/onix-bonsai-onix1</RepositoryUrl>
+    <RepositoryUrl>https://github.com/open-ephys/bonsai-onix1</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>

diff --git a/README.md b/README.md
@@ -3,19 +3,36 @@
 Acquisition System](https://open-ephys.github.io/onix-docs).
 
 - Open Ephys store: https://open-ephys.org/onix
-- Library documentation: https://open-ephys.github.io/onix1-bonsai-docs
+- Library documentation: https://open-ephys.github.io/bonsai-onix1-docs
 - Hardware documentation: https://open-ephys.github.io/onix-docs
 
-### Run in visual studio
+### Run in Visual Studio 2022
 1. Double click the `Setup.cmd` file in the `.bonsai` folder. This will install a
    portable version of Bonsai in the folder along with its required packages.
 1. Open `OpenEphys.Onix1.sln` in Visual Studio (Community Edition is fine).
 1. Select which project to compile and run Bonsai against.
-   - `OpenEphys.Onix1`: core library
+   - `OpenEphys.Onix1`: core library (No GUI elements will be loaded)
    - `OpenEphys.Onix1.Design`: core library and GUI elements
 1. Press the Play button to
    - Compile the library selected in step 3
    - Run the Bonsai application installed in step 1
    - Instruct Bonsai to load the compiled library
 
-<img alt="Select which library to compile" src="./.bonsai/build-and-run.png" width="60%" />
+<img alt="Select which library to compile" src="./images/build-and-run.png" width="60%" />
+
+### Enable debugging
+
+#### Enable child process debugging
+1. Download and install [Microsoft Child Process Debugging Power Tool 2022](https://marketplace.visualstudio.com/items?itemName=vsdbgplat.MicrosoftChildProcessDebuggingPowerTool2022).
+1. Navigate to child process debugging settings.
+1. Check `Enable child process debugging`.
+1. Click <kbd>Save</kbd>.
+
+![Child process debugging](./images/child-process-debugging.webp)
+
+#### Enable native code debugging
+1.  Navigate to debug properties.
+1.  Check `Enable native code debugging`.
+
+![Enable native code debugging](./images/native-code-debugging.webp)
+
diff --git a/images/build-and-run.png b/images/build-and-run.png
diff --git a/images/child-process-debugging.webp b/images/child-process-debugging.webp
diff --git a/images/img-src/child-process-debugging.xcf b/images/img-src/child-process-debugging.xcf
diff --git a/images/img-src/native-code-debugging.xcf b/images/img-src/native-code-debugging.xcf
diff --git a/images/native-code-debugging.webp b/images/native-code-debugging.webp