Skip to content

Commit 78a37ef

Browse files
Add VSCode configuration section to the README (#1)
1 parent f62a4bb commit 78a37ef

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,44 @@ $ julia +Pumas@2.6.1
5353
julia> using Pumas
5454
```
5555

56+
## VSCode Configuration
57+
58+
This section covers the changes that previous Pumas Desktop users, as well as
59+
new users, will need to make.
60+
61+
Start VSCode and then open the "command palette" with `Ctrl+Shift+P` (or with
62+
`Cmd+Shift+P` on macOS). Type in "Open User Settings (JSON)" and select the top
63+
result, which will open an editor window with your user configuration.
64+
65+
Find, or add, the line that starts with `"julia.executablePath"` and change it
66+
to the `julia +Pumas@2.6.1`, or whichever version you installed in the previous
67+
section that you would like to use as your default.
68+
69+
Find, or add, the line that starts with `"julia.additionalArgs"` and remove any
70+
Pumas-specific values from it.
71+
72+
Find, or add, the line that starts with `julia.environmentPath` and set it to
73+
`"~/.julia/environments/Pumas@2.6.1"`, or whichever version you installed in
74+
the previous section.
75+
76+
Find the lines that start with `"QUARTO_JULIA_PROJECT"`, `"QUARTO_JULIA"`, and
77+
`"QUARTONOTEBOOKRUNNER_EXEFLAGS"`. Remove these lines.
78+
79+
> [!IMPORTANT]
80+
>
81+
> This file is a JSON file, so make sure that while removing or editing lines
82+
> you do not leave any trailing `,` in `{}`s or `[]`s.
83+
84+
> [!NOTE]
85+
>
86+
> This is your User settings file, it is global. For each project that you
87+
> start you can have a local `.vscode/settings.json` file that overrides the
88+
> User settings. This is called Workspace settings. It is useful if you need to
89+
> run several different versions of Pumas products in different projects.
90+
> See [the official VSCode documentation](https://code.visualstudio.com/docs/configure/settings#_workspace-settings)
91+
> for details on using Workspace settings. Adjust the product versions that you
92+
> have set in your User settings within your Workspace settings.
93+
5694
## Managing products
5795

5896
All of the `pumas` commands described below require `PumasProductManager` to

0 commit comments

Comments
 (0)