diff --git a/README.md b/README.md index 11471ac0f..37aedb0ee 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A+ good first - +

@@ -69,7 +69,8 @@ DATA_DIR=./ #designate large disk directory 1. Deploy and start -> **Note**: This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command. +> **Note** +> This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command. ``` chmod +x install_im_server.sh; @@ -94,18 +95,19 @@ cd scripts; 2. Clone ``` - git clone https://github.com/OpenIMSDK/Open-IM-Server - cd Open-IM-Server - git checkout release-v3.0 #or other release branch + git clone https://github.com/OpenIMSDK/Open-IM-Server openim && export openim=$(pwd)/openim && cd $openim && make + git checkout release-v3.0 # or other tag ``` +Read about the [OpenIM Version Policy](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/version.md) + 3. Compile ``` - cd Open-IM-server/scripts - chmod +x *.sh - ./build_all_service.sh + cd $openim + make build ``` +`make help` to help you see the instructions supported by OpenIM. All services have been successfully built as shown in the figure