diff --git a/README.md b/README.md index 20f3c6ef..93ec8716 100644 --- a/README.md +++ b/README.md @@ -74,18 +74,32 @@ public function index() { ## 开始 -如果你是初学者,可以直接使用以下脚本部署 PHP 环境和安装框架的脚手架: +框架目前支持 Linux、WSL、macOS 环境直接运行,上述环境可直接使用下方一键安装脚本。 + +> 如果你想在其他环境安装部署,可使用 Docker、Cygwin,详见文档。 ```bash -# 新建一个自己喜欢名字的文件夹,运行一键安装脚本 (仅限 x86-64(AMD64) 和 AArch64(ARM64) 平台) -mkdir zhamao-app/ -cd zhamao-app/ -# 默认安装的 PHP 版本为 7.4,如需使用其他版本,请设置环境变量 ZM_DOWN_PHP_VERSION 为对应的 PHP 版本,例如: -# export ZM_DOWN_PHP_VERSION=8.1 -bash -c "$(curl -fsSL https://api.zhamao.xin/go.sh)" +# 检测PHP环境、安装框架 +bash <(curl -fsSL https://zhamao.xin/go.sh) -# 启动 -./zhamao server:start +# 启动框架 +cd zhamao-app +./zhamao server +``` + +一键安装脚本还有可以自定义参数的方式,比如: + +```bash +# 脚本默认会检测系统的PHP,如果想直接跳过检测,安装独立的PHP版本,则添加此环境变量 +export ZM_NO_LOCAL_PHP="yes" +# 脚本如果安装独立版本PHP,默认版本为8.0,如果想使用其他版本,则添加此环境变量指定版本 +export ZM_DOWN_PHP_VERSION="8.1" +# 脚本默认会将框架在当前目录下的 `zhamao-app` 目录进行安装,如果想使用其他目录,则添加此环境变量 +export ZM_CUSTOM_DIR="my-custom-app" +# 脚本默认会对本项目使用阿里云国内加速镜像,如果想使用packagist源,则添加此环境变量 +export ZM_COMPOSER_PACKAGIST="yes" +# 执行完前面的环境变量再执行一键安装脚本,就可以实现自定义参数! +bash <(curl -fsSL https://zhamao.xin/go.sh) ``` 关于其他安装方式,请参阅[文档](https://framework.zhamao.xin/guide/installation.html) 。 diff --git a/docs/README.md b/docs/README.md index 024f70b1..bda4a3e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,17 +21,16 @@ footer: | ## 安装框架和环境 -此命令可一键以模板安装 `zhamao-framework` 和 `PHP` 独立环境到目录下,无需 root!(仅限 Linux) +此命令可一键以模板安装框架!(仅限 Linux 和 macOS) ```bash -mkdir my-app -cd my-app -bash <(curl -fsSL https://api.zhamao.xin/go.sh) +bash <(curl -fsSL https://zhamao.xin/go.sh) ``` ## 运行框架 ```bash +cd zhamao-app/ ./zhamao server ``` diff --git a/docs/guide/installation.md b/docs/guide/installation.md index bc68cb16..1183a0d5 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -6,21 +6,15 @@ ## 一键下载静态 PHP 环境和框架脚手架 -从 2.4.4 版本起,炸毛框架支持一键拉取一个静态的 PHP 运行时和脚手架,只需运行下面的脚本即可。(开发环境推荐此方法) +从 2.4.4 版本起,炸毛框架支持一键拉取一个静态的 PHP 运行时和脚手架(如果本机内安装的 PHP 已符合要求,则不安装),只需运行下面的脚本即可。 ```bash # 将会把 PHP、框架都安装在此目录下 -mkdir zhamao-app/ # 这里可以取自己的项目名字 -cd zhamao-app/ -bash -c "$(curl -fsSL https://api.zhamao.xin/go.sh)" +bash <(curl -fsSL https://zhamao.xin/go.sh) # 安装完成后的启动框架命令(2.5.0 版本后可省略掉 runtime/php 前缀) +cd zhamao-app ./zhamao server - -# 扩展用法:使用静态 PHP 版本的 Composer update -runtime/composer update -# 扩展用法:使用静态 PHP 运行别的 CLI 脚本 -runtime/php path/to/your/script.php ``` > 有关静态 PHP 的多种用法(如 Composer),见 [进阶 - PHP 环境高级](/advanced/php-env)