Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
eskimo committed Apr 19, 2023
1 parent ffea4fb commit 6d309c8
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,20 @@ Theoretically, Eskimo can be built on any Operating System providing a command l
==== Microsoft Windows

*However, the eskimo source tree makes an extensive use of symbolic links which - unfortunately - are only supported on
Microsoft Windows 10 and 11 through "Developer Mode*.
Microsoft Windows 10 and 11 through "Developer Mode"*.

In order to checkout and develop Eskimo on Windows, some precautions need to be taken:

* First, *Developer Mode* should be enabled on Windows to support symbolic links. +
See https://github.com/MicrosoftDocs/windows-dev-docs/blob/docs/hub/apps/get-started/developer-mode-features-and-debugging.md
* Second, The `git clone` command should explictely enable symbolic link support. That would mean using following
* Second, The `git clone` command should explicitly enable symbolic link support. That would mean using following
command for instance to checkout Eskimo master branch: +
`git clone -c core.symlinks=true https://github.com/eskimo-sh/eskimo.git`

If these two precautions are well taken, one should be able to develop Eskimo. +
A significant portion of the unit tests will however be skipped when executed on Windows since they require a Unix
Operating System to work properly.


=== Building using maven

Expand Down

0 comments on commit 6d309c8

Please sign in to comment.