From 37e258edf21aefaca76580537c5692d746c0741e Mon Sep 17 00:00:00 2001
From: Heikki Linnakangas <heikki.linnakangas@iki.fi>
Date: Tue, 6 Apr 2021 13:55:29 +0300
Subject: [PATCH] Add a brief overview of the source code layout in README

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index bc1a12a0bc..4068b7b537 100644
--- a/README.md
+++ b/README.md
@@ -10,5 +10,35 @@ git clone --recursive https://github.com/libzenith/zenith.git
 cargo test
 ```
 
+## Source tree layout
+
+/walkeeper:
+
+WAL safekeeper. Written in Rust.
+
+/pageserver:
+
+Page Server. Written in Rust.
+
+Depends on the modified 'postgres' binary for WAL redo.
+
+/integration_tests:
+
+Tests with different combinations of a Postgres compute node, WAL safekeeper and Page Server.
+
+/mgmt-console:
+
+Web UI to launch (modified) Postgres servers, using S3 as the backing store. Written in Python.
+This is somewhat outdated, as it doesn't use the WAL safekeeper or Page Servers.
+
+/vendor/postgres:
+
+PostgreSQL source tree, with the modifications needed for Zenith.
+
+/vendor/postgres/src/bin/safekeeper:
+
+Extension (safekeeper_proxy) that runs in the compute node, and connects to the WAL safekeepers
+and streams the WAL
+