Skip to content

Commit

Permalink
docs: refined special Windows setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
quintesse committed Jun 6, 2024
1 parent c373a7f commit ee5776c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
4 changes: 0 additions & 4 deletions docs/modules/ROOT/pages/javaversions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ You can change the default JDK by running:

Running it without an argument will return the version of the JDK that is currently set as the default.

NOTE: On Windows you might need elevated privileges to create symbolic links. If you don't have permissions then
running the above command will result in an error. To use it https://stackoverflow.com/a/24353758[enable symbolic links]
for your user or run your shell/terminal as administrator to have this feature working.

When you `uninstall` a JDK by running:

jbang jdk uninstall 12
Expand Down
7 changes: 3 additions & 4 deletions docs/modules/ROOT/pages/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -348,15 +348,15 @@ No one would want to do that (right?) but now you know.
== Usage on Windows

Some JBang commands need to create symbolic links when running on Windows.
For example, this is required for Managing JDKs or editing the files with the `edit` command.
For example, this is required for editing the files with the `edit` command.

If you encounter issues on Windows related to the creation of symbolic links follow
these instructions:

1. From Windows 10 onwards you can turn on "Developer Mode", this will automatically
enable the possibility to create symbolic links. Read here how to enable this mode:
https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development[Enable your device for development]. On Windows 11 this might already
be enabled by default.
https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development[Enable your device for development].
On Windows 11 this might already be enabled by default.

2. If you're using a Java version equal to or newer than 13 then you're good to go.
This Java version already works correctly. Make sure that JBang is actually using
Expand All @@ -369,4 +369,3 @@ is no other option than setting the correct privileges for your user by enablin
the `Create symbolic links` group policy setting. See the instruction on this page
for more information on how to do this:
https://superuser.com/a/105381[Permission to make symbolic links in Windows].

0 comments on commit ee5776c

Please sign in to comment.