This is an automated email from the ASF dual-hosted git repository.
zrlw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-samples.git
The following commit(s) were added to refs/heads/master by this push:
new 01a0edc92 Clarify prerequisites and external Zookeper setup (#1275)
01a0edc92 is described below
commit 01a0edc92cea237e971b1d9238e0fb1df786b3fc
Author: ishankhemani <[email protected]>
AuthorDate: Thu Jan 8 15:29:03 2026 +0530
Clarify prerequisites and external Zookeper setup (#1275)
* docs:clarify prerequisites and external Zookeper setup
* Correct formatting in README.md
Fixed formatting issues in the README file.
---------
Co-authored-by: zrlw <[email protected]>
---
README.md | 37 +++++++++++++++++++++++++++++++------
1 file changed, 31 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 6f9500ba7..5540c4f9f 100644
--- a/README.md
+++ b/README.md
@@ -6,21 +6,46 @@ Samples for Apache Dubbo.
-This repository contains a number of projects to illustrate various usages of
Dubbo from basic to advanced, pls. check README in each individual sub
projects. It is also helpful to cross reference to [Dubbo User
Manual](https://dubbo.apache.org/zh-cn/overview/tasks/) to understand the
features demoed in this project.
+This repository contains a number of projects to illustrate various usages of
Dubbo from basic to advanced.
+All samples are standard Java, Spring, or Spring Boot applications, and can be
built and run in the same way as normal applications.
+ Please check the README in each individual sub-project for detailed
instructions.
+ It is also helpful to cross reference to [Dubbo User
Manual](https://dubbo.apache.org/zh-cn/overview/tasks/) to understand the
features demoed in this project.
What's more, [dubbo-go](https://github.com/apache/dubbo-go) samples are moved
to [dubbo-go-samples](https://github.com/apache/dubbo-go-samples).
+## Prerequisites
+
+Before running most samples, make sure you have the following installed:
+
+- JDK 8 or later
+- Maven 3.6+
+- ZooKeeper (external)
+
+### ZooKeeper Setup
+
+Samples do not rely on an embedded ZooKeeper by default.
+
+Please download and run a standard ZooKeeper distribution:
+
+1. Download ZooKeeper from https://zookeeper.apache.org/releases.html
+2. Extract the package
+3. Start ZooKeeper:
+
+```bash
+bin/zkServer.sh start
+```
## Build and Run Samples
-To compile all samples, run the following command in the top directory of this
project, or step into the sub directories to compile one single sample:
+**It is highly NOT recommended to build the entire project from the root
directory**, as building all samples can take a long time.
+
+Each sample is designed to be independent. You should navigate to the demo
directory you are interested in and then build and run the sample.
-**It is highly not recommend to build the entire project from the root
directory, as building the entire samples can take a long time. Each module in
Samples is designed independently so you can first go to the demo directory you
care about, then execute the build and run the demo.**
For example,
```bash
-$ cd 1-basic/dubbo-samples-spring-boot
-$ mvn clean package
+cd 1-basic/dubbo-samples-spring-boot
+mvn clean package
```
You may need to read each individual README under the sub directories if you
have to understand how to build and run.
@@ -61,7 +86,7 @@ Then we use the `run-tests.sh` script to run the test cases.
For example, run the `dubbo-samples-annotation` test case:
- ```
+ ```bash
./test/run-tests.sh 2-advanced/dubbo-samples-annotation
```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
