diff --git a/README.markdown b/README.markdown index 04633a8..fc3e29a 100644 --- a/README.markdown +++ b/README.markdown @@ -1,50 +1,52 @@ # libqb +[English](./README.markdown)|[简体中文](./README_CH.md) + ## What is libqb? libqb is a library with the primary purpose of providing high-performance, reusable features for client-server architecture, such as logging, tracing, inter-process communication (IPC), and polling. libqb is not intended to be an all-encompassing library, but instead provide focused APIs that are highly tuned for maximum performance for client-server applications. [![Build Status](https://travis-ci.org/ClusterLabs/libqb.png)](https://travis-ci.org/ClusterLabs/libqb) [![COPR Build Status](https://copr.fedorainfracloud.org/coprs/g/ClusterLabs/devel/package/libqb/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/g/ClusterLabs/devel/package/libqb/) ## For more information, see: * [libqb wiki](https://github.com/clusterlabs/libqb/wiki) * [Issues/Bugs](https://github.com/clusterlabs/libqb/issues) * [The doxygen generated manual](http://clusterlabs.github.io/libqb/CURRENT/doxygen/) * You can build it yourself with the following commands: $ make doxygen $ firefox ./doc/html/index.html ## Dependencies * glib-2.0-devel (If you want to build the glib example code) * check-devel (If you want to run the tests) * doxygen and graphviz (If you want to build the doxygen man pages or html manual) ## Source Control (GIT) git clone git://github.com/ClusterLabs/libqb.git [See Github](https://github.com/clusterlabs/libqb) ## Installing from source $ ./autogen.sh $ ./configure $ make $ sudo make install ## How you can help If you find this project useful, you may want to consider supporting its future development. There are a number of ways to support the project. * Test and report issues. * Help others on the [developers@clusterlabs.org mailing list](http://clusterlabs.org/mailman/listinfo/developers). * Contribute documentation, examples and test cases. * Contribute patches. * Spread the word. diff --git a/README_CH.md b/README_CH.md new file mode 100644 index 0000000..4fd3f04 --- /dev/null +++ b/README_CH.md @@ -0,0 +1,63 @@ +# libqb + +**注意**:中文文档有可能未及时更新,请以最新的英文[README](./README.markdown)为准。 + +## libqb是什么 + +libqb 是为客户端-服务器架构提供高性能、可重用的功能的库,例如日志记录、跟踪、进程间通信 (IPC) 和轮询。 + +libqb 并非旨在成为一个包罗万象的库,而是专注于提供高度优化后的客户端-服务器应用程序API,来使客户端-服务器应用程序达到最佳性能。 + +## 可以通过如下方式了解更多信息 + +- [libqb wiki](https://github.com/clusterlabs/libqb/wiki) + +- [Issues/Bugs](https://github.com/clusterlabs/libqb/issues) + +- [doxygen生成的手册](http://clusterlabs.github.io/libqb/CURRENT/doxygen/) + +- 您也可以使用如下命令自己构建手册 + + ```shell + $ make doxygen + $ firefox ./doc/html/index.html + ``` + +## 依赖 + +- glib-2.0-devel(如果您想构建glib样例代码) + +- check-devel (如果您想运行测试样例) + +- doxygen and graphviz (如果您想构建doxygen man手册或者html手册) + +## 代码管理(git) + +```shell +git clone git://github.com/ClusterLabs/libqb.git +``` + +[查看github](https://github.com/clusterlabs/libqb) + +## 源码编译安装 + +```shell +$ ./autogen.sh +$ ./configure +$ make +$ sudo make install +``` + +## 您如何帮助我们 + +如果您觉得这个项目有用,您可以考虑支持它的未来发展。 有多种方法可以对该项目提供支持: + +- 测试并提交问题 + +- 帮助 [developer@clusterlabs.org 邮件列表](http://clusterlabs.org/mailman/listinfo/developers)中的其他人 + +- 提交文档、示例和测试用例 + +- 提交补丁 + +- 推广项目