This is an automated email from the ASF dual-hosted git repository.
csy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/auron.git
The following commit(s) were added to refs/heads/master by this push:
new 95741ffd [AURON#1991] Improve README formatting and grammar. (#1992)
95741ffd is described below
commit 95741ffdf1d637175ca31983e621c9654d29d884
Author: slfan1989 <[email protected]>
AuthorDate: Mon Feb 9 15:35:23 2026 +0800
[AURON#1991] Improve README formatting and grammar. (#1992)
### Which issue does this PR close?
Closes #1991
### Rationale for this change
- Fix grammar and punctuation issues in README
- Add alt text to logo image for better accessibility
- Update JDK version compatibility info to include JDK 21
- Standardize formatting and spacing throughout the document
### What changes are included in this PR?
- Added `alt="Auron logo"` attribute to logo image
- Fixed article usage: "from distributed computing framework" → "from a
distributed computing framework"
- Corrected plural form: "add the supports" → "add support"
- Fixed inconsistent spacing after colons and bullets in key
capabilities section
- Updated supported JDK versions from "8, 11, and 17" to "8, 11, 17 and
21"
# Are there any user-facing changes?
No.
# How was this patch tested?
No.
---------
Signed-off-by: slfan1989 <[email protected]>
Co-authored-by: Copilot <[email protected]>
---
README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 99ee8b69..d7193a1d 100644
--- a/README.md
+++ b/README.md
@@ -20,21 +20,21 @@
[](https://github.com/apache/auron/actions/workflows/tpcds.yml)
[](https://github.com/apache/auron/actions/workflows/build-amd64-releases.yml)
-<p align="center"><img src="./dev/auron-logo.png" /></p>
+<p align="center"><img src="./dev/auron-logo.png" alt="Auron logo" /></p>
The Auron accelerator for big data engines (e.g., Spark, Flink) leverages
native vectorized execution to accelerate query processing. It combines
the power of the [Apache DataFusion](https://arrow.apache.org/datafusion/)
library and the scale of the distributed
computing framework.
-Auron takes a fully optimized physical plan from distributed computing
framework, mapping it into DataFusion's execution plan, and performs native
+Auron takes a fully optimized physical plan from a distributed computing
framework, mapping it into DataFusion's execution plan, and performs native
plan computation.
The key capabilities of Auron include:
-- **Native execution**: Implemented in Rust, eliminating JVM overhead and
enabling predictable performance.
+- **Native execution**: Implemented in Rust, eliminating JVM overhead and
enabling predictable performance.
- **Vectorized computation**: Built on Apache Arrow's columnar format, fully
leveraging SIMD instructions for batch processing.
-- **Pluggable architecture:**: Seamlessly integrates with Apache Spark while
designed for future extensibility to other engines.
-- **Production-hardened optimizations:** Multi-level memory management,
compacted shuffle formats, and adaptive execution strategies developed through
large-scale deployment.
+- **Pluggable architecture**: Seamlessly integrates with Apache Spark while
designed for future extensibility to other engines.
+- **Production-hardened optimizations**: Multi-level memory management,
compacted shuffle formats, and adaptive execution strategies developed through
large-scale deployment.
Based on the inherent well-defined extensibility of DataFusion, Auron can be
easily extended to support:
@@ -43,8 +43,8 @@ Based on the inherent well-defined extensibility of
DataFusion, Auron can be eas
- Simple and Aggregate functions.
- File formats.
-We encourage you to extend
[DataFusion](https://github.com/apache/arrow-datafusion) capability directly
and add the
-supports in Auron with simple modifications in plan-serde and extension
translation.
+We encourage you to extend
[DataFusion](https://github.com/apache/arrow-datafusion) capability directly
and add support in
+Auron with simple modifications in plan-serde and extension translation.
## Build from source
@@ -58,7 +58,7 @@ We recommend using [rustup](https://rustup.rs/) for
installation.
2. Install JDK
-Auron has been well tested with JDK 8, 11, and 17.
+Auron is regularly tested on JDK 8, 11, and 17, and is also tested on JDK 21.
Make sure `JAVA_HOME` is properly set and points to your desired version.
