Commit af95c074 authored by Liang Ding's avatar Liang Ding

🌐 Add English README

parent 9131d217
# <img src="https://cloud.githubusercontent.com/assets/873584/26024695/4defcb5e-3809-11e7-9755-fa4d22c45718.png"> [Solo](https://github.com/b3log/solo) [![Build Status](https://img.shields.io/travis/b3log/solo.svg?style=flat)](https://travis-ci.org/b3log/solo) [![Coverage Status](https://img.shields.io/coveralls/b3log/solo.svg?style=flat)](https://coveralls.io/github/b3log/solo?branch=master) [![Apache License](http://img.shields.io/badge/license-apache2-orange.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](http://img.shields.io/badge/download-14K+-blue.svg?style=flat)](https://pan.baidu.com/s/1dzk7SU)
* [简介](#简介)
* [功能](#功能)
* [安装](#安装)
* [文档](#文档)
* [技术](#技术)
* [贡献](#贡献)
<p align="center">
<a href="https://github.com/b3log/symphony/blob/master/README.md"><strong>English</strong></a> | <a href="https://github.com/b3log/symphony/blob/master/README_zh_CN.md"><strong>中文</strong></a>
</p>
* [Introduction](#introduction)
* [Features](#features)
* [Screenshots](#screenshots)
* [Installation](#installation)
* [Documents](#documents)
* [Stack](#stack)
* [Contributions](#contributions)
* [Terms](#terms)
* [鸣谢](#鸣谢)
* [Credits](#credits)
## 简介
## Introduction
[Solo](https://github.com/b3log/solo) 是一款**一个命令**就能搭建好的 Java 开源博客系统,并内置了 15+ 套精心制作的皮肤。除此之外,Solo 还有着非常活跃的[社区](https://hacpai.com),文章分享到社区后可以让很多人看到,产生丰富的交流互动。
[Solo](https://github.com/b3log/solo) is a Java open-source blogging system that can be set up with **one command** and has 15+ sets of elaborate skins. In addition, Solo has a very active [community](https://hacpai.com). After the article is shared with the community, it can be seen by many people and generates rich interaction.
Solo 的第一个版本发布于 2010 年,至今已经非常成熟稳定,请放心使用 :smirk_cat:
The first version of Solo was released in 2010 and has been very mature so far. Please feel free to use :smirk_cat:
## 功能
## Features
Solo 沉淀至今的**每一个功能你应该都会用到**。我们不会将只有“20%”用户使用的功能添加进来,只有这样才能保持博客系统本该有的纯净,足够轻量才能带来简约的使用体验。
You should use every function Solo has deposited so far. We will not add features that only "20%" users use. Only in this way can we keep the blog system pure and light enough to bring a simple user experience.
* Markdown / Emoji
* [聚合分类](https://github.com/b3log/solo/issues/12256) / 标签
* 自定义导航(页面、链接)
* 草稿夹
* 评论/回复邮件提醒
* 随机文章 / 相关文章 / 置顶 / 更新提醒
* 自定义文章永久链接
* 自定义站点 SEO 参数
* 自定义公告 / 页脚
* 多个签名档
* 代码高亮
* [多皮肤,多端适配](https://github.com/b3log/solo-skins/tree/master/skin-preview) / [社区皮肤](https://github.com/b3log/solo-third-skins/tree/master/skin-preview)
* 多语言 / 国际化
* 上传七牛云
* 友情链接管理
* 多用户写作,团队博客
* [Hexo/Jekyll 导入](https://hacpai.com/article/1498490209748)
* SQL / JSON / Markdown 导出
* 插件系统
* Atom / RSS 订阅
* [Polymeric classification](https://github.com/b3log/solo/issues/12256) / 标签
* Custom navigation (pages, links)
* Drafts
* Comment/Reply Email Notification
* Random Articles / Related Articles / Sticky / Update Notification
* Custom article permanent link
* Custom site SEO parameters
* Custom announcement / footer
* Multiple signature columns
* Code block highlighting
* [Multi-skin, multi-end fitting](https://github.com/b3log/solo-skins/tree/master/skin-preview) / [Community skin](https://github.com/b3log/solo-third-skins/tree/master/skin-preview)
* Multilingual / International
* Upload local / Qiniu
* Friendship link management
* Multi-user writing, team blog
* [Hexo/Jekyll Import](https://hacpai.com/article/1498490209748)
* SQL / JSON / Markdown Export
* Plugins
* Atom / RSS Feed
* Sitemap
* MetaWeblog API
* CDN 静态资源分离
* CDN Static resource separation
如果有新版可用,升级过程也是非常简单的,只需要重新部署新版本就可以,不用运行额外的任何脚本。
If there is a new version available, the upgrade process is also very simple. You just need to redeploy the new version without running any additional scripts.
## 界面
## Screenshots
编辑文章
Edit
![5f7258675e0143c79e15ddffabf02147-article.png](https://img.hacpai.com/file/2017/8/5f7258675e0143c79e15ddffabf02147-article.png)
选择皮肤
Skin
![ac9a044c18ec4dd4a9356caf698d7fe8-skin.png](https://img.hacpai.com/file/2017/8/ac9a044c18ec4dd4a9356caf698d7fe8-skin.png)
前台界面
Front
* [预览及下载](https://hacpai.com/article/1493814851007#toc_h2_11)
* [Preview and Download](https://hacpai.com/article/1493814851007#toc_h2_11)
## 安装
## Installation
JDK 环境准备好之后[下载](https://pan.baidu.com/s/1dzk7SU)最新的 Solo 包解压,进入解压目录执行:
After the JDK environment is ready, [download](https://pan.baidu.com/s/1dzk7SU) the latest Solo package decompression and enter the decompression directory to execute:
* Windows: `java -cp "WEB-INF/lib/*;WEB-INF/classes" org.b3log.solo.Starter`
* Unix-like: `java -cp "WEB-INF/lib/*:WEB-INF/classes" org.b3log.solo.Starter`
**更多细节请参考 [Solo 用户指南](https://hacpai.com/article/1492881378588)。另外,如果你想用 Solo 但又不想自己维护服务器,可以购买我们搭建好的 Solo 直接[使用](https://b3log.org/services/#solo)。**
**See the [Solo User Guide](https://hacpai.com/article/1492881378588) for more details. In addition, if you want to use Solo but do not want to maintain the server yourself, you can purchase our built Solo and [use it directly](https://b3log.org/services/#solo).**
## 文档
## Documents
* [用户指南](https://hacpai.com/article/1492881378588):安装、配置、备份以及常见问题
* [开发指南](https://hacpai.com/article/1493822943172):开发环境、项目结构、框架说明
* [皮肤开发](https://hacpai.com/article/1493814851007):开发步骤、模版变量
* [插件开发](https://docs.google.com/document/pub?id=15H7Q3EBo-44v61Xp_epiYY7vK_gPJLkQaT7T1gkE64w&pli=1):插件机制、处理流程
* [User Guide](https://hacpai.com/article/1492881378588): Installation, configuration, backup, and frequently asked questions
* [Dev Guide](https://hacpai.com/article/1493822943172): Development environment, project structure, framework description
* [Skin Dev Guide](https://hacpai.com/article/1493814851007): Development steps, template variables
* [Plugin Dev Guide](https://docs.google.com/document/pub?id=15H7Q3EBo-44v61Xp_epiYY7vK_gPJLkQaT7T1gkE64w&pli=1): Plugin mechanism, process flow
## 技术
## Stack
* 后端框架:为了尽量降低服务器的内存占用,顺带尝试[一些技术构想](https://hacpai.com/article/1403847528022),我们开发了 [Latke](https://github.com/b3log/latke) 框架,并在此基础上构建了 [Solo](https://github.com/b3log/solo)[Sym](https://github.com/b3log/symphony)[小薇](https://github.com/b3log/xiaov)等产品。这些产品反过来也会对框架提出需求,这是一个相互促进,共同演化的良性发展过程
* 前端框架:Solo 的前端部分为了降低复杂度, 只依赖于 jQuery、编辑器、代码高亮等组件。管理后台的 SPA 框架、皮肤响应式 UI 都是我们自己实现的
......@@ -89,15 +94,15 @@ JDK 环境准备好之后[下载](https://pan.baidu.com/s/1dzk7SU)最新的 Solo
* 严格的分支、缺陷追踪管理
* 不断完善的测试用例、持续集成
## 贡献
## Contributions
### 作者
### Authors
Solo 的主要作者是 [Daniel](https://github.com/88250)[Vanessa](https://github.com/Vanessa219),所有贡献者可以在[这里](https://github.com/b3log/solo/graphs/contributors)看到。
我们非常期待你加入到这个项目中,无论是使用反馈还是代码补丁,都是对 Solo 一份满满的爱 :heart:
### 讨论区
### Discussion
* 到 Solo 官方[讨论区](https://hacpai.com/tag/Solo)发帖(推荐做法)
* 来一发 [issue](https://github.com/b3log/solo/issues/new)
......@@ -110,7 +115,7 @@ Solo 的主要作者是 [Daniel](https://github.com/88250) 与 [Vanessa](https:/
* If you want to use this software for commercial purpose, please mail to support@liuyun.io for a commercial license request
* Copyright &copy; b3log.org, all rights reserved
## 鸣谢
## Credits
Solo 的诞生离不开以下开源项目:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment