Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and URLs #350

Merged
merged 7 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
<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>
<UseArtifactsOutput>true</UseArtifactsOutput>
<PackageIcon>icon.png</PackageIcon>
<VersionPrefix>0.4.0</VersionPrefix>
<VersionPrefix>0.4.1</VersionPrefix>
<VersionSuffix></VersionSuffix>
<LangVersion>10.0</LangVersion>
<Features>strict</Features>
Expand Down
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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), or find the version of the power tool for the version of Visual Studio used
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)

Binary file added images/build-and-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/child-process-debugging.webp
Binary file not shown.
Binary file added images/img-src/child-process-debugging.xcf
Binary file not shown.
Binary file added images/img-src/native-code-debugging.xcf
Binary file not shown.
Binary file added images/native-code-debugging.webp
Binary file not shown.