diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96a9bf17..01ef520c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,28 @@ # Contributing to RisingLight +- [Contributing to RisingLight](#contributing-to-risinglight) + - [Architecture Design](#architecture-design) + - [Build and Run RisingLight](#build-and-run-risinglight) + - [Create Tracking Issue if Necessary](#create-tracking-issue-if-necessary) + - [Write Documentation](#write-documentation) + - [Write Tests](#write-tests) + - [Running Test and Checks](#running-test-and-checks) + - [Sign DCO (Developer Certificate of Origin)](#sign-dco-developer-certificate-of-origin) + - [Send Pull Requests](#send-pull-requests) + Thanks for your contribution! The RisingLight project welcomes contribution of various types -- new features, bug fixes and reports, typo fixes, etc. If you want to contribute to the RisingLight project, you will need to pass necessary checks and sign DCO. If you have any question, feel free to ping community members on GitHub and in Slack channels. Besides sending Pull Requests, you may also take part in our community scrum meeting (see [README](README.md) for more information), chat in Slack channels, and become a RisingLight member (see [GOVERNANCE](GOVERNANCE.md) for more information). -Also you may take a look at the [architecture overview](./docs/03-architecture-overview.md) to have a better idea of RisingLight's design. +## Architecture Design + +You may take a look at the [architecture overview](./docs/03-architecture-overview.md) to have a better idea of RisingLight's design. + +## Build and Run RisingLight + +Please refer to [Install, Run, and Develop RisingLight](./docs/00-develop.md) for more information. ## Create Tracking Issue if Necessary diff --git a/README.md b/README.md index 094be01c..809fa276 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,12 @@ Currently, RisingLight only supports Linux or macOS. If you are familiar with th start an interactive shell with: ``` -cargo run -# or start in release mode -cargo run --release +cargo run # start in debug mode +cargo run --release # or start in release mode ``` -Otherwise, see [Install, Run, and Develop RisingLight](docs/00-develop.md) for more information. We provide -step-by-step guide on how to compile and run RisingLight from scratch. +If you meet with any build issues, see [Install, Run, and Develop RisingLight](docs/00-develop.md) for more +information. We provide step-by-step guide on how to compile and run RisingLight from scratch. After successfully building RisingLight, you may import some data and run SQL queries. See [Running TPC-H Queries](docs/01-tpch.md). diff --git a/docs/00-develop.md b/docs/00-develop.md index 001dfeda..175ad50c 100644 --- a/docs/00-develop.md +++ b/docs/00-develop.md @@ -24,6 +24,23 @@ version of nightly toolchain, as it is using some experimental features in the R sites only retain recent versions of nightly releases. If you encountered errors when downloading Rust toolchains, you may switch to a mirror site with full Rust toolchain or use the official rustup source. +## Install Tools + +RisingLight uses protobuf to encode some on-disk data. Therefore, you will need to install protobuf compiler +or toolchains to build protobuf compiler in advance. + + +On Debian-based Linux distros, + +```bash +sudo apt install make build-essential cmake protobuf-compiler +``` + +On macOS with Homebrew, + +```bash +brew install cmake protobuf +``` ## Compile RisingLight