Updated the installation instructions, especially for optional window…

…s tools 'file' and 'grep'.
wummel · Oct 6, 2024 · 5349e3d · 5349e3d
1 parent 6ec0587
commit 5349e3d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 12 deletions.
diff --git a/doc/changelog.txt b/doc/changelog.txt
@@ -1,6 +1,8 @@
-3.0.1 (released xx.xx.xxxx)
+3.0.1 (released 05.10.2024)
   * Use more uv command to replace other build tools, ie. twine.
   * Add new --quiet option to suppress command output.
+  * Document that Windows needs a file program to be able to determine file types without extensions.
+    Closes: GH bug #152
 
 3.0.0 (released 25.09.2024)
   * When a program does not support a compression type, try to find other programs instead of failing.

diff --git a/doc/install.md b/doc/install.md
@@ -30,15 +30,17 @@ Now install the application.
       [Modifying Python's search path](http://docs.python.org/inst/search-path.html#SECTION000410000000000000000)
       documentation.
 
-3. Optional: install cygwin file package on Windows
+3. Optional: install cygwin file and grep packages on Windows
 
    On Windows systems, the archive type is only detectable through file extensions.
    To be able to detect archives with missing or non-standard file extensions,
    you have to install the `file` package from [cygwin](https://cygwin.com/).
 
+   For `patool search`, the `grep` program is needed.
+
    a) Download the [cygwin installer setup-x86_64.exe](https://cygwin.com/setup-x86_64.exe)
 
-   b) Run `setup-x86_64.exe -q -p file`
+   b) Run `setup-x86_64.exe -q -p file,grep`
 
    c) Add the `c:\cygwin64\bin` directory to your PATH
 

diff --git a/doc/web/source/index.md b/doc/web/source/index.md
@@ -46,19 +46,14 @@ sudo pip install patool
 And on Windows:
 
 ```bash
-c:\python3\scripts\pip install patool
+py.exe -m pip install patool
 ```
 
-Or after downloading the patool .whl file:
+You will need Python 3.10 or later.
 
-```bash
-c:\python3\scripts\pip install patool-1.9-py2.py3-none-any.whl
-```
-
-You will need at least Python 3.10.
+For more information, especially for installing additional tools on Windows, read the detailed
+[installation instructions](https://github.com/wummel/patool/blob/master/doc/install.md).
 
-If you install from source read the
-[installation instructions](https://github.com/wummel/patool/blob/master/doc/install.txt).
 
 Running
 --------