From 69746f699f01f7b33d411cd4ddceeeb3e26b5139 Mon Sep 17 00:00:00 2001 From: Pol Dellaiera Date: Sat, 1 Jul 2023 14:20:19 +0200 Subject: [PATCH] docs: add binary dependencies (#11505) --- README.md | 18 ++++++++++++++++++ doc/00-intro.md | 10 ++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a7d02282..09a1ab73e 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,24 @@ PHP versions 5.3.2 - 8.1 are still supported via the LTS releases of Composer (2 run the installer or the `self-update` command the appropriate Composer version for your PHP should be automatically selected. +#### Binary dependencies + +- `7z` (or `7zz`) +- `unzip` (if `7z` is missing) +- `gzip` +- `tar` +- `unrar` +- `xz` +- Git (`git`) +- Mercurial (`hg`) +- Fossil (`fossil`) +- Perforce (`p4`) +- Subversion (`svn`) + +It's important to note that the need for these binary dependencies may vary +depending on individual use cases. However, for most users, only 2 dependencies +are essential for Composer: `7z` (or `7zz` or `unzip`), and `git`. + Authors ------- diff --git a/doc/00-intro.md b/doc/00-intro.md index ad43c94f6..7c08bd380 100644 --- a/doc/00-intro.md +++ b/doc/00-intro.md @@ -39,8 +39,14 @@ a legacy PHP version. A few sensitive php settings and compile flags are also required, but when using the installer you will be warned about any incompatibilities. -To install packages from sources instead of plain zip archives, you will need -git, svn, fossil or hg depending on how the package is version-controlled. +Composer needs several supporting applications to work effectively, making the +process of handling package dependencies more efficient. For decompressing +files, Composer relies on tools like `7z` (or `7zz`), `gzip`, `tar`, `unrar`, +`unzip` and `xz`. As for version control systems, Composer integrates seamlessly +with Fossil, Git, Mercurial, Perforce and Subversion, thereby ensuring the +application's smooth operation and management of library repositories. Before +using Composer, ensure that these dependencies are correctly installed on your +system. Composer is multi-platform and we strive to make it run equally well on Windows, Linux and macOS.