Skip to content

[ISSUE #34] Update README.md doc about how to start name server #35

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 12, 2024
Merged

[ISSUE #34] Update README.md doc about how to start name server #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions README-zh_cn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,46 @@

### 运行NameServer

根据下面的命令运行NameServer
**运行下面命令查看使用**：

- **windows 平台**

```cmd
cargo run --bin rocketmq-namesrv-rust -- --help

RocketMQ Name server(Rust)

Usage: rocketmq-namesrv-rust.exe [OPTIONS]

Options:
-p, --port <PORT> rocketmq name server port [default: 9876]
-i, --ip <IP> rocketmq name server ip [default: 127.0.0.1]
-h, --help Print help
-V, --version Print version
```

- **Linux 平台**

```shell
$ cargo run --bin rocketmq-namesrv-rust -- --help

RocketMQ Name server(Rust)

Usage: rocketmq-namesrv-rust [OPTIONS]

Options:
-p, --port <PORT> rocketmq name server port [default: 9876]
-i, --ip <IP> rocketmq name server ip [default: 127.0.0.1]
-h, --help Print help
-V, --version Print version
```

**根据下面的命令运行NameServer**

```shell
cargo run --bin rocketmq-namesrv
cargo run --bin rocketmq-namesrv-rust
```



## 模块

现有的Rocketmq主要有如下几个功能模块：
Expand Down
38 changes: 36 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,44 @@

### Run name server

**Run the following command to see usage：**

- **windows platform**

```cmd
cargo run --bin rocketmq-namesrv-rust -- --help

RocketMQ Name server(Rust)

Usage: rocketmq-namesrv-rust.exe [OPTIONS]

Options:
-p, --port <PORT> rocketmq name server port [default: 9876]
-i, --ip <IP> rocketmq name server ip [default: 127.0.0.1]
-h, --help Print help
-V, --version Print version
```

- **Linux platform**

```shell
$ cargo run --bin rocketmq-namesrv-rust -- --help

RocketMQ Name server(Rust)

Usage: rocketmq-namesrv-rust [OPTIONS]

Options:
-p, --port <PORT> rocketmq name server port [default: 9876]
-i, --ip <IP> rocketmq name server ip [default: 127.0.0.1]
-h, --help Print help
-V, --version Print version
```

Run the following command to start the name server

```shell
cargo run --bin rocketmq-namesrv
cargo run --bin rocketmq-namesrv-rust
```

## Modules
Expand Down Expand Up @@ -66,4 +100,4 @@ Contributions to code, issue reporting, and suggestions are welcome. The develop

## License

RocketMQ-Rust is licensed under the [Apache License 2.0](https://github.com/mxsm/rocketmq-rust/blob/main/LICENSE-APACHE) and [MIT license](https://github.com/mxsm/rocketmq-rust/blob/main/LICENSE-MIT)
RocketMQ-Rust is licensed under the [Apache License 2.0](https://github.com/mxsm/rocketmq-rust/blob/main/LICENSE-APACHE) and [MIT license](https://github.com/mxsm/rocketmq-rust/blob/main/LICENSE-MIT)