aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-01-04 13:02:07 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-01-04 13:02:07 +0300
commit65ec4a1b55cd54bdbe38bd80376601c8fa31f9d7 (patch)
treed24b00fbfb3f459ad0a56d3d3a268a0cf44bd470
parentrename symlinks-to-hardlinks to just hardlinks (diff)
downloadsetup-cygwin-65ec4a1b55cd54bdbe38bd80376601c8fa31f9d7.tar.gz
setup-cygwin-65ec4a1b55cd54bdbe38bd80376601c8fa31f9d7.zip
README: update
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 2f63653..79893d3 100644
--- a/README.md
+++ b/README.md
@@ -24,12 +24,6 @@ the `packages` parameter.
(C:\tools\cygwin is the default).
* The `CYGWIN` environment variable is set to an empty string by default.
Provide a custom value using the `env` parameter.
-* Some packages install symlinks in /usr/bin along with real executables.
-An example is package python3, which (as of January 2021) installs symlink
-"python3", pointing to the real executable "python3.8.exe".
-Calling Cygwin symlinks from Windows' command prompt is unsupported, but
-there's an option to convert them to hardlinks instead (the `hardlinks`
-parameter).
API
---
@@ -49,6 +43,16 @@ API
The paths to the Cygwin binaries are added to the PATH variable.
+Notes
+-----
+
+1. Some packages install symlinks in /usr/bin along with real executables.
+An example is package "python3", which (as of January 2021) installs symlink
+`python3`, pointing to the real executable `python3.8.exe`.
+Calling Cygwin symlinks from Windows' command prompt is unsupported, but might
+be convenient (e.g. if you don't know the exact Python version), so there's an
+option to convert them to hardlinks instead (the `hardlinks` parameter).
+
License
-------