mirror of
https://github.com/bs-community/blessing-skin-server.git
synced 2025-02-17 14:49:27 +08:00
update readme
This commit is contained in:
parent
ae687b8cf5
commit
835ce71a16
22
README.md
22
README.md
@ -37,10 +37,10 @@ Blessing Skin 是一个开源的 PHP 项目,这意味着您可以自由地在
|
||||
|
||||
## 环境要求
|
||||
|
||||
Blessing Skin 对您的服务器有一定的要求。_在大多数情况下,下列所需的 PHP 扩展已经开启。_
|
||||
Blessing Skin 对您的服务器有一定的要求。在大多数情况下,下列所需的 PHP 扩展已经开启。
|
||||
|
||||
- 一台支持 URL 重写的主机,Nginx 或 Apache
|
||||
- **PHP >= 7.2.5** [(服务器不支持?)](https://blessing.netlify.com/versions.html)
|
||||
- PHP >= 7.2.5
|
||||
- 安装并启用如下 PHP 扩展:
|
||||
- OpenSSL
|
||||
- PDO
|
||||
@ -55,9 +55,7 @@ Blessing Skin 对您的服务器有一定的要求。_在大多数情况下,
|
||||
|
||||
## 快速使用
|
||||
|
||||
请参阅 [安装指南](https://blessing.netlify.com/setup.html)。
|
||||
|
||||

|
||||
请参阅 [安装指南](https://blessing.netlify.app/setup.html)。
|
||||
|
||||
## 插件系统
|
||||
|
||||
@ -102,6 +100,13 @@ Blessing Skin 提供了强大的插件系统,您可以通过添加多种多样
|
||||
HyperCol
|
||||
</a>
|
||||
</td>
|
||||
<td align=center>
|
||||
<a href="">
|
||||
<img src="https://pic1.afdiancdn.com/default/avatar/avatar-purple.png" width="120" height="120">
|
||||
<br>
|
||||
graytoowolf
|
||||
</a>
|
||||
</td>
|
||||
<td align=center>
|
||||
<a href="">
|
||||
<img src="https://pic1.afdiancdn.com/default/avatar/avatar-purple.png" width="120" height="120">
|
||||
@ -151,7 +156,7 @@ Blessing Skin 提供了强大的插件系统,您可以通过添加多种多样
|
||||
|
||||
## 国际化(i18n)
|
||||
|
||||
Blessing Skin 可支持多种语言,当前支持英语(`en`)和简体中文(`zh_CN`)。
|
||||
Blessing Skin 可支持多种语言,当前支持英语、简体中文和西班牙语。
|
||||
|
||||
当然,您也可以添加您自己的语言。请参阅 [添加其它语言](https://blessing.netlify.com/i18n.html)
|
||||
|
||||
@ -161,6 +166,11 @@ Blessing Skin 可支持多种语言,当前支持英语(`en`)和简体中
|
||||
|
||||
请参阅 [报告问题的正确姿势](https://blessing.netlify.com/report.html)。
|
||||
|
||||
## 相关链接
|
||||
|
||||
- [用户手册](https://blessing.netlify.app/)
|
||||
- [插件开发文档](https://bs-plugin.netlify.app/)
|
||||
|
||||
## 版权
|
||||
|
||||
MIT License
|
||||
|
77
README_EN.md
77
README_EN.md
@ -37,28 +37,25 @@ Blessing Skin is an open-source project written in PHP, which means you can depl
|
||||
|
||||
## Requirements
|
||||
|
||||
Blessing Skin has only a few system requirements. _In most cases, these PHP extensions are already enabled._
|
||||
Blessing Skin has only a few system requirements. In most cases, these PHP extensions are already enabled.
|
||||
|
||||
- Web server with URL rewriting enabled (Nginx or Apache)
|
||||
- **PHP >= 7.2.5**
|
||||
- OpenSSL PHP Extension
|
||||
- PDO PHP Extension
|
||||
- Mbstring PHP Extension
|
||||
- Tokenizer PHP Extension
|
||||
- GD PHP Extension
|
||||
- XML PHP Extension
|
||||
- Ctype PHP Extension
|
||||
- JSON PHP Extension
|
||||
- fileinfo PHP Extension
|
||||
- zip PHP Extension
|
||||
- PHP >= 7.2.5
|
||||
- PHP Extensions
|
||||
- OpenSSL
|
||||
- PDO
|
||||
- Mbstring
|
||||
- Tokenizer
|
||||
- GD
|
||||
- XML
|
||||
- Ctype
|
||||
- JSON
|
||||
- fileinfo
|
||||
- zip
|
||||
|
||||
## Quick Install
|
||||
|
||||
1. Download our [latest release](https://github.com/bs-community/blessing-skin-server/releases), extract to where you like to installed on.
|
||||
2. Rename `.env.example` to `.env` and configure your database information. (For windows users, just rename it to `.env.`, and the last dot will be removed automatically)
|
||||
3. For Nginx users, add [rewrite rules](#configure-the-web-server) to your Nginx configuration
|
||||
4. Navigate to `http://your-domain.com/setup` in your browser. If 404 is returned, please check whether the rewrite rules works correctly.
|
||||
5. Follow the setup wizard and your website is ready-to-go.
|
||||
Please read [Installation Guide](https://blessing.netlify.app/en/setup.html).
|
||||
|
||||
## Plugin System
|
||||
|
||||
@ -103,6 +100,13 @@ Currently you can sponsor us via [爱发电](https://afdian.net/@blessing-skin).
|
||||
HyperCol
|
||||
</a>
|
||||
</td>
|
||||
<td align=center>
|
||||
<a href="">
|
||||
<img src="https://pic1.afdiancdn.com/default/avatar/avatar-purple.png" width="120" height="120">
|
||||
<br>
|
||||
graytoowolf
|
||||
</a>
|
||||
</td>
|
||||
<td align=center>
|
||||
<a href="">
|
||||
<img src="https://pic1.afdiancdn.com/default/avatar/avatar-purple.png" width="120" height="120">
|
||||
@ -144,45 +148,28 @@ Currently you can sponsor us via [爱发电](https://afdian.net/@blessing-skin).
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Developer Install
|
||||
## Build From Source
|
||||
|
||||
Please refer to [here](https://blessing.netlify.com/build.html).
|
||||
|
||||
## Configure the Web Server
|
||||
|
||||
For Apache (most of the virtual hosts) users, there is already a pre-configured file for you. What you need is just to enjoy!
|
||||
|
||||
For Nginx users, **please add the following rules** to your Nginx configuration file:
|
||||
|
||||
```
|
||||
location / {
|
||||
try_files $uri $uri/ /index.php?$query_string;
|
||||
}
|
||||
|
||||
location ~ /\.env {
|
||||
deny all;
|
||||
}
|
||||
```
|
||||
|
||||
## Mod Configuration
|
||||
|
||||
Please refer to [Mod Configuration](https://blessing.netlify.com/en/mod.html).
|
||||
|
||||

|
||||
Please refer to [Manual Build](https://blessing.netlify.app/build.html).
|
||||
|
||||
## Internationalization
|
||||
|
||||
Blessing Skin supports multiple languages, while currently supporting English (`en`) and Simplified Chinese (`zh_CN`).
|
||||
Blessing Skin supports multiple languages, while currently supporting English, Simplified Chinese and Spanish.
|
||||
|
||||
Of course, you can add your own language. Please check [Add other language [i18n]](https://blessing.netlify.com/i18n.html) (Simplified Chinese only).
|
||||
Of course, you can add your own language. Please check [Add other language [i18n]](https://blessing.netlify.app/i18n.html) (Simplified Chinese only).
|
||||
|
||||
If you are willing to contribute your translation, welcome to join [our Crowdin project](https://crowdin.com/project/blessing-skin).
|
||||
|
||||
## Report Bugs
|
||||
|
||||
Read [FAQ](https://blessing.netlify.com/faq.html) and double check if your situation doesn't suit any case mentioned there before reporting.
|
||||
Read [FAQ](https://blessing.netlify.app/faq.html) and double check if your situation doesn't suit any case mentioned there before reporting.
|
||||
|
||||
When reporting a problem, please attach your log file (located at `storage/logs/laravel.log`) and the information of your server where the error occured on. You should also read this [guide](https://blessing.netlify.com/report.html) before reporting a problem.
|
||||
When reporting a problem, please attach your log file (located at `storage/logs/laravel.log`) and the information of your server where the error occured on. You should also read this [guide](https://blessing.netlify.app/report.html) before reporting a problem.
|
||||
|
||||
## Related Links
|
||||
|
||||
- [User Manual](https://blessing.netlify.app/en/)
|
||||
- [Plugins Development Documentation](https://bs-plugin.netlify.app/)
|
||||
|
||||
## Copyright & License
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user