Skip to content

Update create-package pre-requisites #150

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −3
Open

Update create-package pre-requisites #150

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
13 changes: 10 additions & 3 deletions articles/create-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,16 @@ The Bonsai language can be extended with custom packages, which are installed an

## Pre-requisites

1. [Visual Studio](https://www.visualstudio.com/). You can install the Community edition for free.
1. Install [Visual Studio](https://www.visualstudio.com/). You can install the Community edition for free, the version 2022 works.

2. Bonsai VS Extensions. From the Windows Start Menu, search for the "**Install Bonsai VS Extensions**" shortcut and run it.
2. Install [.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download)

3. In a command-line terminal, run:

```dotnet new install Bonsai.Templates::2.9.0```

The templates can now be found in visual studio (you can use Visual Studio Community 2022) and it should look like this:
<img width="2013" height="990" alt="469548332-668dd4a3-aa0f-4bff-972d-218654bdb312" src="https://github.com/user-attachments/assets/bb36869e-b0a8-4d80-87a8-c94bcf1926ef" />

## Creating a package project

Expand Down Expand Up @@ -118,4 +125,4 @@ The Bonsai language can be extended with custom packages, which are installed an
> If you have your custom package installed in the same editor used to debug the source code, Bonsai will prefer the installed package over the compiled source code library. In this case, either uninstall the package, or use a local Bonsai installation.

> [!Note]
> If you would like to share the package with the broader Bonsai community, consider publishing it to [NuGet](https://www.nuget.org/packages/manage/upload) by creating a NuGet account and uploading the `.nupkg` file. Ensure the `PackageType` field is properly defined before submission.
> If you would like to share the package with the broader Bonsai community, consider publishing it to [NuGet](https://www.nuget.org/packages/manage/upload) by creating a NuGet account and uploading the `.nupkg` file. Ensure the `PackageType` field is properly defined before submission.