refactor readme
This commit is contained in:
zhangzifa
20
CONTRIBUTING.md
Normal file
20
CONTRIBUTING.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Contributing to this SDK project
|
||||
|
||||
We work hard to provide a high-quality and useful SDK for Alibaba Cloud, and
|
||||
we greatly value feedback and contributions from our community. Please submit
|
||||
your [issues](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues) or [pull requests](https://github.com/aliyun/aliyun-openapi-cpp-sdk/pulls) through GitHub.
|
||||
|
||||
## Tips
|
||||
|
||||
- The SDK is released under the [Apache license][license]. Any code you submit
|
||||
will be released under that license. For substantial contributions, we may
|
||||
ask you to sign a [Alibaba Documentation Corporate Contributor License
|
||||
Agreement (CLA)][cla].
|
||||
- We maintain a high percentage of code coverage in our unit tests. If you make
|
||||
changes to the code, please add, update, and/or remove tests as appropriate.
|
||||
|
||||
[issues]: https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues
|
||||
[pull-requests]: https://github.com/aliyun-openapi-cpp-sdk/pulls
|
||||
[license]: http://www.apache.org/licenses/LICENSE-2.0
|
||||
[cla]: https://alibaba-cla-2018.oss-cn-beijing.aliyuncs.com/Alibaba_Documentation_Open_Source_Corporate_CLA.pdf
|
||||
[docs-readme]: https://github.com/aliyun/aliyun-openapi-cpp-sdk/blob/master/README.md
|
||||
51
README.md
51
README.md
@@ -1,24 +1,33 @@
|
||||
# Alibaba Cloud C++ Software Development Kit
|
||||
[中文文档](./README_zh.md)
|
||||
English | [简体中文](./README_zh.md)
|
||||
|
||||
[](https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk)
|
||||
[](https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk)
|
||||
|
||||
The Alibaba Cloud C++ Software Development Kit (SDK) allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests.
|
||||
<p align="center">
|
||||
<a href="https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/AlibabaCloud.svg"></a>
|
||||
</p>
|
||||
|
||||
This document introduces how to obtain and call Alibaba Cloud C++ SDK.
|
||||
<h1 align="center">Alibaba Cloud SDK for C++</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk"><img src="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk.svg?branch=master" alt="Travis Build Status"></a>
|
||||
<a href="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk"><img src="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk/branch/master/graph/badge.svg" alt="codecov"></a>
|
||||
</p>
|
||||
|
||||
|
||||
The SDK allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests.
|
||||
|
||||
This document introduces how to obtain and call this SDK.
|
||||
|
||||
If you have any problem while using C++ SDK, please submit an [issue](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new).
|
||||
|
||||
## Prerequisites
|
||||
## Requirements
|
||||
|
||||
- To use Alibaba Cloud C++ SDK, you must have an Alibaba Cloud account and an AccessKey.
|
||||
- To use this SDK, you must have an Alibaba Cloud account and an AccessKey.
|
||||
|
||||
The AccessKey is required when initializing the client. You can create an AccessKey in the Alibaba Cloud console. For more information, see [Create an AccessKey](https://usercenter.console.aliyun.com/?spm=5176.doc52740.2.3.QKZk8w#/manage/ak).
|
||||
|
||||
>**Note:** To increase the security of your account, we recommend that you use the AccessKey of the RAM user to access Alibaba Cloud services.
|
||||
|
||||
- To use Alibaba Cloud C++ SDK to access the APIs of a product, you must first activate the product on the [Alibaba Cloud console](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w) if required.
|
||||
- To use this SDK to access the APIs of a product, you must first activate the product on the [Alibaba Cloud console](https://home.console.aliyun.com/?spm=5176.doc52740.2.4.QKZk8w) if required.
|
||||
|
||||
- C++11 supported compiler installed
|
||||
- Windows: Visual Studio 2015 or newer
|
||||
@@ -26,8 +35,7 @@ If you have any problem while using C++ SDK, please submit an [issue](https://gi
|
||||
- CMake 3.0 or newer
|
||||
- 4G memory or more
|
||||
|
||||
## Install C++ SDK from source code
|
||||
|
||||
## Installation
|
||||
|
||||
### Linux
|
||||
|
||||
@@ -106,9 +114,9 @@ If you have any problem while using C++ SDK, please submit an [issue](https://gi
|
||||
**SDK will be installed to `C:\Program File (x86)\alibabacloud-sdk`**
|
||||
|
||||
|
||||
## Use the C++ SDK
|
||||
## Quick Examples
|
||||
|
||||
Before using C++ SDK, you must first configure the preprocessor to define `ALIBABACLOUD_SHARED` to achieve dynamic linking with Alibaba Cloud C++ SDK shared libraries. Then you must create a client instance, specify the region of cloud services and provide authentication parameters before sending API requests.
|
||||
Before using this SDK, you must first configure the preprocessor to define `ALIBABACLOUD_SHARED` to achieve dynamic linking with the SDK shared libraries. Then you must create a client instance, specify the region of cloud services and provide authentication parameters before sending API requests.
|
||||
|
||||
The following code shows how to call the [DescribeInstances](~~25506~~) API of ECS to query detailed information of all ECS instances in a specific region.
|
||||
|
||||
@@ -222,9 +230,18 @@ int main(int argc, char** argv) {
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
**More [examples](https://github.com/aliyun/aliyun-openapi-cpp-sdk/tree/master/examples)**
|
||||
|
||||
## LICENSE
|
||||
Please refer to [LICENSE](https://github.com/aliyun/aliyun-openapi-cpp-sdk/blob/master/LICENSE) (Apache 2.0 LICENSE).
|
||||
## Issues
|
||||
[Opening an Issue](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new/choose), Issues not conforming to the guidelines may be closed immediately.
|
||||
|
||||
## Changelog
|
||||
Detailed changes for each release are documented in the [release notes](CHANGELOG).
|
||||
|
||||
## Contribution
|
||||
Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request.
|
||||
|
||||
## License
|
||||
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
Copyright 1999-2019 Alibaba Group Holding Ltd.
|
||||
41
README_zh.md
41
README_zh.md
@@ -1,17 +1,24 @@
|
||||
# 阿里云开发者C++工具套件
|
||||
[English](./README.md) | 简体中文
|
||||
|
||||
[](https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk)
|
||||
[](https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk)
|
||||
|
||||
欢迎使用阿里云开发者工具套件（SDK）。
|
||||
<p align="center">
|
||||
<a href="https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/Aliyun.svg"></a>
|
||||
</p>
|
||||
|
||||
适用于阿里云的 C++ SDK 提供了一组现代化的 C++（C++ 11 或更高版本）接口，让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。
|
||||
<h1 align="center">Alibaba Cloud SDK for C++</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk"><img src="https://travis-ci.org/aliyun/aliyun-openapi-cpp-sdk.svg?branch=master" alt="Travis Build Status"></a>
|
||||
<a href="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk"><img src="https://codecov.io/gh/aliyun/aliyun-openapi-cpp-sdk/branch/master/graph/badge.svg" alt="codecov"></a>
|
||||
</p>
|
||||
|
||||
|
||||
欢迎使用阿里云开发者工具套件（SDK）。阿里云 C++ SDK 让您不用复杂编程即可访问云服务器、云监控等阿里云服务。这里向您介绍如何获取阿里云 C++ SDK 并开始调用。
|
||||
|
||||
如果您在使用SDK的过程中遇到任何问题，欢迎前往[阿里云SDK问答社区](https://yq.aliyun.com/tags/type_ask-tagid_23350)提问，提问前请阅读[提问引导](https://help.aliyun.com/document_detail/93957.html)。亦可在当前 GitHub [提交 Issues](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new)。
|
||||
|
||||
完成本文档中的操作开始使用 C++ SDK。
|
||||
|
||||
## 前提条件
|
||||
## 环境要求
|
||||
|
||||
在使用 C++ SDK 前，确保您已经：
|
||||
|
||||
@@ -28,7 +35,7 @@
|
||||
* 安装 CMake 3.0 或以上版本
|
||||
* 建议 4G 或以上内存
|
||||
|
||||
## 从源代码构建 SDK
|
||||
## 安装 C++ SDK (从源代码构建)
|
||||
|
||||
1. 从 GitHub 下载或 Git 克隆 [aliyun-openapi-cpp-sdk](https://github.com/aliyun/aliyun-openapi-cpp-sdk)
|
||||
|
||||
@@ -110,7 +117,7 @@ msbuild INSTALL.vcxproj
|
||||
|
||||
**注意：请以管理员身份运行 Visual Studio，否则无法安装 SDK**
|
||||
|
||||
## 如何使用 C++ SDK
|
||||
## 快速使用
|
||||
|
||||
在调用 C++ SDK时，您首先需要配置预处理器定义 ALIBABACLOUD_SHARED 以引用阿里云 C++ SDK 的共享库，然后通过创建 Client 实例提供身份验证，并指定云服务的地域，然后发送API请求。
|
||||
|
||||
@@ -234,8 +241,18 @@ int main(int argc, char** argv) {
|
||||
```
|
||||
|
||||
|
||||
**更多 [例程](https://github.com/aliyun/aliyun-openapi-cpp-sdk/tree/master/examples)**
|
||||
|
||||
**更多 [例程](https://github.com/aliyun/aliyun-openapi-cpp-sdk/tree/master/examples) 请(参考)[https://github.com/aliyun/aliyun-openapi-cpp-sdk/blob/master/examples/README_zh.md]**
|
||||
## 问题
|
||||
[提交 Issue](https://github.com/aliyun/aliyun-openapi-cpp-sdk/issues/new/choose), 不符合指南的问题可能会立即关闭。
|
||||
|
||||
## 许可协议
|
||||
请参阅 LICENSE 文件（Apache 2.0 许可证）。
|
||||
## 发行说明
|
||||
每个版本的详细更改记录在[发行说明](CHANGELOG)中。
|
||||
|
||||
## 贡献
|
||||
提交 Pull Request 之前请阅读[贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
版权所有 1999-2019 阿里巴巴集团
|
||||
|
||||
Reference in New Issue
Block a user