[skip ci] Refine scripts readme (#9408)

Signed-off-by: Edward Zeng <jie.zeng@zilliz.com>
This commit is contained in:
edward.zeng 2021-10-07 18:34:42 +08:00 committed by GitHub
parent 21655d54be
commit d278fffca1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,7 +12,7 @@
## Install dependencies
Install compile dependencies
```shell script
```shell
sudo apt install -y g++ gcc make libssl-dev zlib1g-dev libboost-regex-dev \
libboost-program-options-dev libboost-system-dev libboost-filesystem-dev \
libboost-serialization-dev python3-dev libboost-python-dev libcurl4-openssl-dev gfortran libtbb-dev
@ -23,7 +23,7 @@ Install compile dependencies
Install OpenBlas library
```shell script
```shell
wget https://github.com/xianyi/OpenBLAS/archive/v0.3.9.tar.gz && \
tar zxvf v0.3.9.tar.gz && cd OpenBLAS-0.3.9 && \
make TARGET=CORE2 DYNAMIC_ARCH=1 DYNAMIC_OLDER=1 USE_THREAD=0 USE_OPENMP=0 FC=gfortran CC=gcc COMMON_OPT="-O3 -g -fPIC" FCOMMON_OPT="-O3 -g -fPIC -frecursive" NMAX="NUM_THREADS=128" LIBPREFIX="libopenblas" LAPACKE="NO_LAPACKE=1" INTERFACE64=0 NO_STATIC=1 && \
@ -34,26 +34,26 @@ Install OpenBlas library
Generate the go files from proto file
```shell script
```shell
make check-proto-product
```
Check code specifications
```shell script
```shell
make verifiers
```
Compile milvus
```shell script
```shell
make all
```
## Install docker-compose
refer: https://docs.docker.com/compose/install/
```shell script
```shell
sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
@ -63,13 +63,13 @@ refer: https://docs.docker.com/compose/install/
## Start service
Start third-party service:
```shell script
```shell
cd [milvus project path]/deployments/docker/cluster
docker-compose up -d
```
Start milvus cluster:
```shell script
```shell
cd [milvus project path]/scripts
start_cluster.sh
```
@ -77,33 +77,33 @@ Start milvus cluster:
## Run unittest
Run all unittest including go and cpp cases:
```shell script
```shell
make unittest
```
You also can run go unittest only:
```shell script
```shell
make test-go
```
Run cpp unittest only:
```shell script
```shell
make test-cpp
```
## Run code coverage
Run code coverage including go and cpp:
```shell script
```shell
make codecov
```
You also can run go code coverage only:
```shell script
```shell
make codecov-go
```
Run cpp code coverage only:
```shell script
```shell
make codecov-cpp
```
```