Skip to content

Commit de64f11

Browse files
committed
docs: optimize
1 parent b162444 commit de64f11

File tree

6 files changed

+18
-14
lines changed

6 files changed

+18
-14
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
## v1.0.0 (2023-12-05)
4+
5+
### Features
6+
7+
- all: first version

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ tRPC-Java has the following features:
3232

3333
### Dependency environment
3434

35-
JDK 8+, Maven 3.6.3+
35+
JDK 1.8.0_251+, Maven 3.6.3+
3636

3737
### Import dependencies
3838

README.zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ tRPC-Java 具有以下特点:
3131

3232
### 依赖环境
3333

34-
JDK 8+, Maven 3.6.3+
34+
JDK 1.8.0_251+, Maven 3.6.3+
3535

3636
### 引入依赖
3737

docs/en/1.quick_start.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
### Prerequisites
22

3-
- **[Java](https://github.com/openjdk/jdk)**, should be greater or equal than 8.
3+
- **[Java](https://github.com/openjdk/jdk)**, should be greater or equal than 1.8.0_251.
44
- **[Maven](https://maven.apache.org/)**, should be greater or equal than 3.6.3.
55

66
### Get Example Code
77

88
Example code is part of `tRPC-Java` repo. Clone and change directory to `tRPC-Java`.
99

1010
```bash
11-
$ git clone git@github.com:trpc-group/trpc-java.git
11+
$ git clone https://github.com/trpc-group/trpc-java.git
1212
$ cd trpc-java
1313
```
1414

@@ -37,11 +37,9 @@ classes within the IDE.
3737
To install `tRPC-Java` and its dependencies locally, execute the following command:
3838

3939
```bash
40-
$ mvn clean install
40+
$ mvn -Dmaven.test.skip=true clean install
4141
```
4242

43-
> _If you don't want to run the unit tests during dependency installation, you can execute `mvn -Dmaven.test.skip=true clean install`._
44-
4543
#### Run the Server-Side Example Codes
4644

4745
To run the server-side example codes, you can execute the following command:

docs/zh/1.quick_start.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
### 准备工作
22

3-
- **[Java](https://github.com/openjdk/jdk)**版本应大于等于8
3+
- **[Java](https://github.com/openjdk/jdk)**版本应大于等于1.8.0_251
44
- **[Maven](https://maven.apache.org/)** ,版本应大于等于3.6.3。
55

66
### 获取示例代码
77

88
示例代码是`tRPC-Java`仓库的一部份,先克隆`tRPC-Java`仓库到本地目录。
99

1010
```bash
11-
$ git clone git@github.com:trpc-group/trpc-java.git
11+
$ git clone https://github.com/trpc-group/trpc-java.git
1212
$ cd trpc-java
1313
```
1414

@@ -35,11 +35,9 @@ trpc-demo
3535
执行以下命令,本地安装`tRPC-Java`及其依赖:
3636

3737
```bash
38-
$ mvn clean install
38+
$ mvn -Dmaven.test.skip=true clean install
3939
```
4040

41-
> _如果安装依赖时不想执行单测,可执行`mvn -Dmaven.test.skip=true clean install`_
42-
4341
#### 运行服务端示例代码
4442

4543
执行以下命令运行服务端示例代码:

trpc-limiter/trpc-limiter-sentinel/src/test/java/com/tencent/trpc/limiter/sentinel/config/datasource/RedisDatasourceConfigTest.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* Tencent is pleased to support the open source community by making tRPC available.
33
*
4-
* Copyright (C) 2023 THL A29 Limited, a Tencent company.
4+
* Copyright (C) 2023 THL A29 Limited, a Tencent company.
55
* All rights reserved.
66
*
77
* If you have downloaded a copy of the tRPC source code from Tencent,
@@ -33,7 +33,8 @@ public class RedisDatasourceConfigTest {
3333
@Before
3434
public void setUp() {
3535

36-
redisServer = RedisServer.builder().port(port).build();
36+
redisServer = RedisServer.builder().setting("maxmemory 128M").setting("bind localhost")
37+
.port(port).build();
3738
redisServer.start();
3839
}
3940

0 commit comments

Comments
 (0)