aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2026-08-09 20:04:28 +0900
committernsfisis <nsfisis@gmail.com>2026-08-09 20:04:28 +0900
commitbad46664a71c8e12330d548c07e2daae90b54e75 (patch)
treee469e2d62caa1cfec7d31b708788e9b610692ee5
parent78c23c7105914b74ae91c71496265d3b03d7e285 (diff)
downloadphp-shirabe-bad46664a71c8e12330d548c07e2daae90b54e75.tar.gz
php-shirabe-bad46664a71c8e12330d548c07e2daae90b54e75.tar.zst
php-shirabe-bad46664a71c8e12330d548c07e2daae90b54e75.zip
docs(readme): list the build requirements
The build reads the SPDX license data out of the Composer submodule's vendor directory, which composer install has to populate first. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 736c22ee..f3f22741 100644
--- a/README.md
+++ b/README.md
@@ -17,10 +17,21 @@ Shirabe runs Composer plugins using the system-provided real PHP. The plugin API
* [phpstan/extension-installer](https://github.com/phpstan/extension-installer)
+## Requirements
+
+Building Shirabe requires:
+
+* Rust toolchain
+* Git
+* PHP
+* Composer
+
+
## Build
```
$ git submodule update --init
+$ composer install --no-dev --working-dir=composer
$ cargo build --release
```