Browse Source

update Readme with Windows notes

Daniel Sheffield 2 weeks ago
parent
commit
045ab07cd3
1 changed files with 10 additions and 0 deletions
  1. 10 0
      Readme.md

+ 10 - 0
Readme.md

@@ -2,6 +2,15 @@
 
 
 Manage your personal dotfiles with [GNU Stow](https://www.gnu.org/software/stow/manual/stow.html).
 Manage your personal dotfiles with [GNU Stow](https://www.gnu.org/software/stow/manual/stow.html).
 
 
+GNU Stow can be used directly, but a helper script `./dot` is provided to easy
+the syntax and to support my custom package [Target](#targets) feature.
+
+This is a Linux first design, but there is rudimentry support for Windows.
+
+> Windows users should use the `./dot.ps1` script instead of the `./dot` script.
+>
+> As GNU Stow is currently unavailable on Windows, `./park.ps1` provides bare minimum functionality for the `./dot.ps1` Windows implementation.
+
 ## Usage
 ## Usage
 
 
 Keep your dotfiles in your git repo and symlink them into the correct place, allowing you to edit them without forgetting to copy those changes back into your repo.
 Keep your dotfiles in your git repo and symlink them into the correct place, allowing you to edit them without forgetting to copy those changes back into your repo.
@@ -89,6 +98,7 @@ Or, if the `vim` package has no other [targets](#targets), you can use GNU Stow
 ```
 ```
 stow -t "$HOME" vim
 stow -t "$HOME" vim
 ```
 ```
+> Windows users may use the `park.ps1` script as GNU Stow
 
 
 Multiple [targets](#targets) are supported in the case a given package has a mix of user config and system config.
 Multiple [targets](#targets) are supported in the case a given package has a mix of user config and system config.