Skip to content

Commit 634a54c

Browse files
cjshacjshabparks13jonnew
authored
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]>
1 parent 4d7d712 commit 634a54c

7 files changed

+23
-6
lines changed

Directory.Build.props

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
<PropertyGroup>
44
<Authors>Open Ephys</Authors>
55
<Copyright>Copyright © Open Ephys and Contributors 2024</Copyright>
6-
<PackageProjectUrl>https://open-ephys.github.io/onix1-bonsai-docs</PackageProjectUrl>
6+
<PackageProjectUrl>https://open-ephys.github.io/bonsai-onix1-docs</PackageProjectUrl>
77
<GenerateDocumentationFile>true</GenerateDocumentationFile>
88
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
99
<IncludeSymbols>true</IncludeSymbols>
10-
<RepositoryUrl>https://github.com/open-ephys/onix-bonsai-onix1</RepositoryUrl>
10+
<RepositoryUrl>https://github.com/open-ephys/bonsai-onix1</RepositoryUrl>
1111
<RepositoryType>git</RepositoryType>
1212
<PackageReadmeFile>README.md</PackageReadmeFile>
1313
<PackageLicenseFile>LICENSE</PackageLicenseFile>

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,36 @@
33
Acquisition System](https://open-ephys.github.io/onix-docs).
44

55
- Open Ephys store: https://open-ephys.org/onix
6-
- Library documentation: https://open-ephys.github.io/onix1-bonsai-docs
6+
- Library documentation: https://open-ephys.github.io/bonsai-onix1-docs
77
- Hardware documentation: https://open-ephys.github.io/onix-docs
88

9-
### Run in visual studio
9+
### Run in Visual Studio 2022
1010
1. Double click the `Setup.cmd` file in the `.bonsai` folder. This will install a
1111
portable version of Bonsai in the folder along with its required packages.
1212
1. Open `OpenEphys.Onix1.sln` in Visual Studio (Community Edition is fine).
1313
1. Select which project to compile and run Bonsai against.
14-
- `OpenEphys.Onix1`: core library
14+
- `OpenEphys.Onix1`: core library (No GUI elements will be loaded)
1515
- `OpenEphys.Onix1.Design`: core library and GUI elements
1616
1. Press the Play button to
1717
- Compile the library selected in step 3
1818
- Run the Bonsai application installed in step 1
1919
- Instruct Bonsai to load the compiled library
2020

21-
<img alt="Select which library to compile" src="./.bonsai/build-and-run.png" width="60%" />
21+
<img alt="Select which library to compile" src="./images/build-and-run.png" width="60%" />
22+
23+
### Enable debugging
24+
25+
#### Enable child process debugging
26+
1. Download and install [Microsoft Child Process Debugging Power Tool 2022](https://marketplace.visualstudio.com/items?itemName=vsdbgplat.MicrosoftChildProcessDebuggingPowerTool2022).
27+
1. Navigate to child process debugging settings.
28+
1. Check `Enable child process debugging`.
29+
1. Click <kbd>Save</kbd>.
30+
31+
![Child process debugging](./images/child-process-debugging.webp)
32+
33+
#### Enable native code debugging
34+
1. Navigate to debug properties.
35+
1. Check `Enable native code debugging`.
36+
37+
![Enable native code debugging](./images/native-code-debugging.webp)
38+

images/build-and-run.png

10.7 KB
Loading

images/child-process-debugging.webp

30.7 KB
Binary file not shown.
213 KB
Binary file not shown.
264 KB
Binary file not shown.

images/native-code-debugging.webp

28.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)