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.

Sign up for GitHub

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

Add build instructions to README #225

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Add build instructions to README #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added .bonsai/build-and-run.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,17 @@ Acquisition System](https://open-ephys.github.io/onix-docs).
- Library documentation: https://open-ephys.github.io/onix1-bonsai-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 `.bonsai` folder along with the Bonsai packages
required to compile and run the library.
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.Design`: core library and GUI elements
1. Press the Play button to
- Compile the library
- Run the Bonsai application installed in step 1
- Instruct Bonsai to load the compiled library

![Select which library to compile](./.bonsai/build-and-run.png)