From 924962de0682f975ce3496195a1d4f39d35b3248 Mon Sep 17 00:00:00 2001 From: Stas Kelvich Date: Tue, 30 Mar 2021 03:22:07 +0300 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++------------------------- 1 file changed, 10 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index a5ec91b73b..bc1a12a0bc 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,14 @@ -# zenith +# Zenith -This is the top level repo containing the following submodules +Zenith substitutes PostgreSQL storage layer and redistributes data across a cluster of nodes -1. vendor/postgres - upstream postgres code - * zenith branch contains our changes - * These changes are relatively small and will be either upstreamed or - moved to an extension - -2. pageserver - the code that deals with buffer pages disaggregated from - compute nodes. - -3. walkeeper - the code that takes the WAL from postgres and signals to - postgres when it's safe to consider a transaction committed. - -4. consensus - Implement distributed consensus between compute and storage - nodes. - -5. cli - Tooling used to have a friendly workflow that allows migration to/from - zenith storage system and cloud provider's object storage services. - -Recommended workflow: +## Running tests +```sh +git clone --recursive https://github.com/libzenith/zenith.git +./pgbuild.sh # builds postgres and installs it to ./tmp_install +cargo test ``` -$ git clone https://github.com/libzenith/zenith -$ git submodule update --init --recursive -$ cargo build -$ cargo test -``` + + +