Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Prerequisite and Build source code section #2

Merged
merged 9 commits into from Sep 17, 2019

Conversation

@ykgarfield
Copy link
Contributor

commented Sep 12, 2019

No description provided.

@TisonKun

This comment has been minimized.

Copy link
Collaborator

commented Sep 12, 2019

ref #1

Copy link
Collaborator

left a comment

Thanks for your contribution @ykgarfield! The content looks good to me.

However, I think it would be better if we convert the descriptive guide into a manual-like guide. That is, instead of document it in long sentence, we list out the prerequisite by items and build guide step by step.

You can take a look at the corresponding section in Apache Flink or one of my personal project

@gosonzhang

This comment has been minimized.

Copy link
Collaborator

commented Sep 12, 2019

Thanks

Copy link
Collaborator

left a comment

Thanks for your updates @ykgarfield! The changes look good to me.

+1 to merge.

@gosonzhang please take a look when you're free.

@TisonKun TisonKun referenced this pull request Sep 16, 2019
- Maven
- [protoc 2.5.0](https://github.com/protocolbuffers/protobuf/releases/tag/v2.5.0)

## Install protoc

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 16, 2019

Collaborator

I suggest removing this ## Install protoc section. One concern is the instructions are only for Windows; another concern is protoc is just prerequisites as others. People should be able to find how to install protoc through Internet. That should be enough we list it as an item of prerequistes.

This comment has been minimized.

Copy link
@ykgarfield

ykgarfield Sep 17, 2019

Author Contributor

It's a good suggestion, I will remove


Others os can following the protobuf official docuement.

## Build source code

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 16, 2019

Collaborator

Can we merge this section with the below one? Build source code and Build looks like duplicated. IMHO, It should be a supplement of the build section.

Maybe change it to

Build

Go to the project root, and run

mvn clean package -Dmaven.test.skip

Each module of the project can also be build separately.

If want to build and debug source code in IDE, go to the project root, and run

mvn compile

This command will generate .proto files corresponding Java source files(location is target/generated-sources).

When this command finished, you can use IDE import the project as maven project.

This comment has been minimized.

Copy link
@ykgarfield

ykgarfield Sep 17, 2019

Author Contributor

Yes, at that time, I also think these two sections are a bit duplicated.Can the Build section divided into two child sections.One is Build distribution tarball, the others is Build source code, this is a bit clearer.

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 17, 2019

Collaborator

Yes. I'm okay with that

@@ -1,11 +1,30 @@
# TubeMQ User Guide
## Prerequisites

- Java 7/8(Java 9+ are not test)

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 17, 2019

Collaborator

tested?

Go to the project root, and run
```bash
mvn clean package -Dmaven.test.skip
```
Each module of the project can also be build separately.

### Build source code
If want to build and debug source code in IDE, go to the project root, and run

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 17, 2019

Collaborator

If you want to...?

mvn compile
```

This command will generate `.proto` files corresponding Java source files(location is `target/generated-sources`).

This comment has been minimized.

Copy link
@yiheng

yiheng Sep 17, 2019

Collaborator

corresponding to Java source files...?

@yiheng

This comment has been minimized.

Copy link
Collaborator

commented Sep 17, 2019

Thanks for your contribution. Can you also fix some small typos? Others look good to me.

@yiheng yiheng merged commit cbc9f2e into Tencent:master Sep 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.