diff --git a/README.md b/README.md index 9885a99640c9f42368b73cea7fb4e524801b6b1c..39709da5d4c11e690f0a478f51482231a85b22e2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,54 @@ -# Hikari +![Hikari 一个基于php的静态博客系统](https://cdn.learnku.com/uploads/images/202102/05/62927/3SRlVH8ZYr.png!large) -Hikari是一个博客框架。 +[官网/文档](http://hikari.xtzero.me/) +[Github](https://github.com/xtzero/hikari) +[Gitee](https://gitee.com/xtzero/hikari/tree/master) + +# 简介 +Hikari是一个简介、高效、可定制的博客系统。 + +Hikari使用php开发,可以使用简单的命令来生成一个精美的博客网站。 + +Hikari完美支持markdown文档,在写作时,你可以全部使用markdown书写,然后使用简单的命令,即可看到你作品展现的结果。 + +Hikari的文档同样支持Html标签,你可以通过在markdown中插入简单的html标签和css样式来美化页面。 + +如果你有开发能力,你甚至可以将Hikari定制成为任何你想要的样子。 + +# 快速开始 + +## 环境要求 + ++ Windows 7 + / Linux / MacOS ++ php 7.4.1 + ++ composer 1.9.1 + + +## 下载 + +前往 [Hikari 的gitee首页](https://gitee.com/xtzero/hikari/),克隆代码到本地。 + +```shell +$ git clone git@gitee.com:xtzero/hikari.git +$ cd hikari +``` + +## 安装 + +使用`composer`进行安装。 + +```shell +$ composer install -vvv +``` + +## 运行 + +```shell +$ php hikari s +... +Started develop server: http://localhost:8517 +You can use 'php hikari b' in another terminal to rebuild dist files! +``` + +# LICENSE +GNU GPL -[Gitee](https://gitee.com/xtzero/hikari)