You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by di...@apache.org on 2019/01/07 11:09:04 UTC

[rocketmq-client-go] branch master updated: update Introduction (#24)

This is an automated email from the ASF dual-hosted git repository.

dinglei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-client-go.git


The following commit(s) were added to refs/heads/master by this push:
     new a6b9713  update Introduction (#24)
a6b9713 is described below

commit a6b9713b795d9ae804f26353f53e6af9c630b11e
Author: wenfeng <sx...@gmail.com>
AuthorDate: Mon Jan 7 06:09:00 2019 -0500

    update Introduction (#24)
---
 doc/Introduction.md | 55 +++++++++++++++++++----------------------------------
 1 file changed, 20 insertions(+), 35 deletions(-)

diff --git a/doc/Introduction.md b/doc/Introduction.md
index 9ad1650..ecc6bff 100644
--- a/doc/Introduction.md
+++ b/doc/Introduction.md
@@ -1,45 +1,30 @@
-----------
-## RocketMQ Client Go
+## Prerequisites
 
-### 1. Go Version
-* go1.10.5 darwin/amd64
+### Install `librocketmq`
+because the project top on [rocketmq-client-cpp](https://github.com/apache/rocketmq-client-cpp), so you need install 
+`librocketmq` first.
 
+#### include file
+```bash
+git clone https://github.com/apache/rocketmq-client-cpp
 
-### 2. Dependency
-* [librocketmq](https://github.com/apache/rocketmq-client-cpp)	
+# By default, CFLAGS contains `/usr/local/include`
+sudo mkdir -p /usr/local/include/rocketmq/
+sudo cp rocketmq-client-cpp/include/* /usr/local/include/rocketmq
+```
 
-### 3. Build and Install
-#### macOS Platform (macOS Mojave 10.14)
-* Install Compile tools (homebrew package manager)
-    ```
-    1. xcode-select --install
-    2. brew install cmake
-    3. brew install automake
-    ```
-* Install dependencies
-    1. [Go official download](https://golang.org/dl/)
-
-    2. Get go client package
-    ```
-    go get github.com/apache/rocketmq-client-go
-    ```
-    3. [librocketmq](https://github.com/apache/rocketmq-client-cpp)
-        - `git clone https://github.com/apache/rocketmq-client-cpp`
-        - `cd rocketmq-client-cpp`
-        - `sudo sh build.sh` 
-        - `sudo install bin/librocketmq.dylib /usr/local/lib`
-        - `sudo mkdir /usr/local/include/rocketmq`
-        - `sudo cp include/* /usr/local/include/rocketmq/`
-
-#### Linux
-
-*coming soon*
+#### binary library
+your could download directly or build manually:
 
-#### Windows
+- download specific release: [rocketmq-client-cpp-1.2.0](http://opensource-rocketmq-client-us.oss-us-west-1.aliyuncs.com/cpp-client/libindex.log)
+ and move files downloaded to your `LDFLAGS` directory(if you don't know what is `LDFLAGS`, just google it), in linux, `/usr/local/lib/` works finely.
+ 
+- build from source: [Build and Install](https://github.com/apache/rocketmq-client-cpp/tree/master#build-and-install)
 
-*coming soon*
+### install
+1. Go Version: 1.10 or later
+2. `go get github.com/apache/rocketmq-client-go`
 
-----------
 ## How to use
 
 - import package