Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.27 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.27 KB
Raw

substrait-cpp

Planned home for CPP libraries to help build/consume Substrait query plans.

Getting Started

We provide scripts to help developers setup and install substrait-cpp dependencies.

Get the substrait-cpp Source

git clone --recursive https://github.com/substrait-io/substrait-cpp.git
cd substrait-cpp
# if you are updating an existing checkout
git submodule sync --recursive
git submodule update --init --recursive

Setting up on Linux (Ubuntu 20.04 or later)

Once you have checked out substrait-cpp, you can set up and build like so:

$ ./scripts/setup-ubuntu.sh 
$ make

Coding style

Basically the coding style is based on Google C++ Style, but there are some naming style changed:

  • Function case style change to 'camelBack'
  • Variable case style change to 'camelBack'
  • Class Member case style change to 'camelBack' with '_' as suffix

For more detail information please refer to .clang-tidy under root directory.

You can run make format script to formatting source code and run make tidy to checking coding style, and run make tidy-fixto fix the coding style automatically.

License

substrait-cpp is licensed under the Apache 2.0 License. A copy of the license can be found here.