Skip to content
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.

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

Add build guidance for mac users #169

Merged
merged 3 commits into from
Aug 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,19 @@ apt install git curl gcc g++ libssl-dev pkg-config cmake

需要注意的是,项目的编译对 cmake、gcc、g++ 等实际上都是有版本要求的,如果开发环境使用的是较老的 Linux 发行版的话,一般需要手动安装较高版本的这些依赖。


#### 开发依赖(MacOS)
开发环境这里以 MacOS Monterey 为例,执行如下的命令,即可安装好所需的依赖。

1. 安装命令行工具:
```shell
xcode-select --install
```
2. 通过Brew安装cmake:
```shell
brew install cmake
```

#### Rust
Rust 的安装建议通过 [rustup](https://rustup.rs/),安装了 rustup 之后,进入到 CeresDB 项目的时候,会自动根据 rust-toolchain 文件下载指定的 Rust 版本。

Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ apt install git curl gcc g++ libssl-dev pkg-config cmake

It should be noted that the compilation of the project has version requirements for dependencies such as cmake, gcc, g++, etc. If your development environment is an old Linux distribution, it is necessary to manually install these dependencies of a higher version.

#### Dependencies(MacOS)
If the development environment is MacOS, execute the following command to install the required dependencies.

1. Install command line tools:
```shell
xcode-select --install
```
2. Install cmake:
```shell
brew install cmake
```

#### Rust
`Rust` can be installed by [rustup](https://rustup.rs/). After installing rustup, when entering the CeresDB project, the specified `Rust` version will be automatically downloaded according to the rust-toolchain file.

Expand Down