Skip to content

Commit

Permalink
docs: removed special Windows setup instructions
Browse files Browse the repository at this point in the history
They are no longer needed now that we can create junctions
  • Loading branch information
quintesse committed May 28, 2024
1 parent 0ac0b79 commit 471ea37
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 35 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ BUILD SUCCESSFUL in 5s
The guidelines above should work for Windows, and this configuration is covered by the CI pipeline.
Some tests may be skipped in your local environment if symbolic linking is not enabled for your filesystem
OR if your test process does not have the required permissions for a directory.
See the configuration guidelines in the link:readme.adoc#usage-on-windows[Usage on Windows] section.

== Conventional Commits + squash and merge

Expand Down
4 changes: 0 additions & 4 deletions docs/modules/ROOT/pages/editing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,6 @@ code `jbang edit --no-open helloworld.java`

If you add further dependencies to your file just re-run the edit command and the relevant files will be regenerated with the updated dependencies.

NOTE: On Windows you might need elevated privileges to create symbolic links. If you don't have permissions then
the `edit` option 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.

== Live Editing

You can also use `jbang edit --live` and `jbang` will launch your editor while watching
Expand Down
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
26 changes: 0 additions & 26 deletions docs/modules/ROOT/pages/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -344,29 +344,3 @@ If you need to specify a main class you can do so by using `--main` i.e.
A side effect of running GAV as a jar, the GAV could also be a `.java` or `.jsh` file and it would be launched as a script instead of a jar.
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.

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.

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
that Java version, either by running `java -version` to check if the Java on the
`PATH` is version 13 or newer, or if you don't have Java available on the `PATH`
by running `jbang jdk default 13` (or some newer version of course).

3. If you need symbolic links to work on older Java versions as well, then there
is no other option than setting the correct privileges for your user by enabling
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 471ea37

Please sign in to comment.