Skip to content

Commit fe89e5b

Browse files
committed
Clean up line endings and whitespace
1 parent a09a27b commit fe89e5b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

articles/environments.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ If you have many projects, you might notice that older projects require specific
1111
`Bonsai` addresses these problems by supporting the creation of reproducible package environments. An environment is a self-contained, portable, installation of `Bonsai` that records a *snapshot* of all the packages required to run the workflows in your project. This makes it much easier to share a project with other people, or keep track of multiple separate projects in your local machine, and be assured you always have everything you need in the right place.
1212

1313
## Environment Basics
14+
1415
The key to creating and updating environments is the `Bonsai.config` file, which keeps a record of all currently installed dependencies for a specific Bonsai setup. You can find this file in the same location of the Bonsai executable (`Bonsai.exe`). Anytime you install or update a package, Bonsai will automatically modify the config file.
1516

1617
The contents of the `Bonsai.config` file are compared with the current state of the `Packages` folder when Bonsai starts. If there are any missing packages the Bonsai bootstrapper will download them automatically to recover the expected state of the installation folder.
1718

1819
There is a second configuration file located next to the `Bonsai.config` file called `NuGet.config`. This file stores a list of all the remote, and local, NuGet package sources where the [`Package Manager`](xref:packages) should look for new packages. While this file needs to be included in the environment, most users do not need to modify it.
1920

2021
## Portable Method
22+
2123
> [!TIP]
2224
> We recommend this approach for the casual user.
2325
@@ -46,7 +48,7 @@ We have also provided a command-line tool for "one-click" deployment which insta
4648

4749
1. Download the [Bonsai installer](https://bonsai-rx.org/docs/articles/installation.html).
4850
2. When running the installer, ensure that **Add to PATH (requires shell restart)** is selected within **Options**.
49-
3. Navigate to the folder where you want to create a new Bonsai environment and run this command.
51+
3. Navigate to the folder where you want to create a new Bonsai environment and run this command.
5052

5153
```cmd
5254
bonsai --init
@@ -66,6 +68,7 @@ bonsai --no-editor
6668
```
6769

6870
## Adding Local Dependencies
71+
6972
> [!TIP]
7073
> For [new package](xref:create-package) developers, you may need to install local NuGet packages as dependencies during testing.
7174
@@ -94,6 +97,7 @@ You can also use relative paths if you want to keep package sources relative to
9497
Similar to `Bonsai.config` the `NuGet.config` file will be used as part of the bootstrapper process when `Bonsai.exe` starts.
9598

9699
## Version Control
100+
97101
To keep track of environments, all that is needed are these two files.
98102

99103
- `NuGet.config`
@@ -107,4 +111,4 @@ To prevent installed packages and other binary files from being tracked, you can
107111
Packages
108112
*.exe
109113
*.exe.settings
110-
```
114+
```

0 commit comments

Comments
 (0)