From 806a9631d70a1e4be5021e017304ee2ce5d4b7fc Mon Sep 17 00:00:00 2001
From: Andrew Lamb <andrew@nerdnetworks.org>
Date: Mon, 30 Oct 2023 09:17:02 -0400
Subject: [PATCH] Add README.md to `core`, `execution` and `physical-plan`
 crates (#7970)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Add README.md to `core`, `execution` and `physical-plan` crates

* prettier

* Update datafusion/physical-plan/README.md

* Update datafusion/wasmtest/README.md

---------

Co-authored-by: Daniël Heres <danielheres@gmail.com>
---
 datafusion/core/README.md          | 26 ++++++++++++++++++++++++++
 datafusion/execution/README.md     | 26 ++++++++++++++++++++++++++
 datafusion/physical-plan/README.md | 27 +++++++++++++++++++++++++++
 datafusion/wasmtest/README.md      | 11 +++++++++--
 4 files changed, 88 insertions(+), 2 deletions(-)
 create mode 100644 datafusion/core/README.md
 create mode 100644 datafusion/execution/README.md
 create mode 100644 datafusion/physical-plan/README.md

diff --git a/datafusion/core/README.md b/datafusion/core/README.md
new file mode 100644
index 000000000000..c83e33991a07
--- /dev/null
+++ b/datafusion/core/README.md
@@ -0,0 +1,26 @@
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+
+# DataFusion Common
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate contains the main entrypoints and high level DataFusion APIs such as SessionContext, and DataFrame and ListingTable.
+
+[df]: https://crates.io/crates/datafusion
diff --git a/datafusion/execution/README.md b/datafusion/execution/README.md
new file mode 100644
index 000000000000..40b3ffaa3ed3
--- /dev/null
+++ b/datafusion/execution/README.md
@@ -0,0 +1,26 @@
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+
+# DataFusion Common
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion that provides execution runtime such as the memory pools and disk manager.
+
+[df]: https://crates.io/crates/datafusion
diff --git a/datafusion/physical-plan/README.md b/datafusion/physical-plan/README.md
new file mode 100644
index 000000000000..3632ea7d2a26
--- /dev/null
+++ b/datafusion/physical-plan/README.md
@@ -0,0 +1,27 @@
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+
+# DataFusion Common
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion that contains the `ExecutionPlan` trait and the various implementations of that
+trait for built in operators such as filters, projections, joins, aggregations, etc.
+
+[df]: https://crates.io/crates/datafusion
diff --git a/datafusion/wasmtest/README.md b/datafusion/wasmtest/README.md
index 5dc7bb2de45d..21e505f38e02 100644
--- a/datafusion/wasmtest/README.md
+++ b/datafusion/wasmtest/README.md
@@ -17,9 +17,16 @@
   under the License.
 -->
 
-## wasmtest
+# DataFusion wasmtest
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion used to verify that various DataFusion crates compile successfully to the
+`wasm32-unknown-unknown` target with wasm-pack.
 
-Library crate to verify that various DataFusion crates compile successfully to the `wasm32-unknown-unknown` target with wasm-pack.
+[df]: https://crates.io/crates/datafusion
+
+## wasmtest
 
 Some of DataFusion's downstream projects compile to WASM to run in the browser. Doing so requires special care that certain library dependencies are not included in DataFusion.