针对文档提交 README 文件,能够让文档在 GITHUB 中显示内容和相关链接

This commit is contained in:
YuCheng Hu 2019-07-24 12:57:31 -04:00
parent 817b4e6568
commit ba827555f3
1 changed files with 30 additions and 0 deletions

30
README.adoc Normal file
View File

@ -0,0 +1,30 @@
= Protocol Buffers 文档
YuCheng Hu <yhu@ossez.com>
:doctype: book
:page-layout: docs
:page-description: Protocol Buffers
:page-keywords: Protocol Buffers
Protocol Buffers 相关文档的内容,本文档是针对官方的文档进行翻译和编辑的。
image::https://travis-ci.org/cwiki-us-docs/protocol-buffers-docs.svg?branch=master[]
image::http://docs.ossez.com/protocol-buffers-docs/images/protocol-buffers-logo.jpg[]
== 文档和资料
针对 Protocol Buffers 相关的文档和资料的快速链接。
=== WIKI 和已编译的文档
* https://www.cwiki.us/display/ProtocolBuffers/Protocol+Buffers - cwiki.us 的 Protocol Buffer WIKI
* http://docs.ossez.com/protocol-buffers-docs/index.html - Protocol Buffer 技术资料
=== SCM (Source Control Management) 源代码
* https://github.com/cwiki-us-docs/protocol-buffers-docs - Protocol Buffers 文档的源代码
* https://github.com/cwiki-us-demo/protocol-buffers-demo-java - Protocol Buffers 文档的源代码示例程序
== Protocol Buffers 简介
我们是在实际的数据处理的时候,需要使用 JSON 来序列化数据,但是又考虑到 JSON 在传输的时候数据过大,同时还有很多并不需要的垃圾文件。
我们才考虑到了 Protocol Buffer 提供的功能。
image::http://docs.ossez.com/protocol-buffers-docs/images/protocol-buffers-serialization.png[]