From 8ba0cdfcff81725b22f3e797517fc58bf2f87bac Mon Sep 17 00:00:00 2001 From: Justin Mclean Date: Thu, 4 Jan 2024 17:41:31 +1100 Subject: [PATCH] [MINOR] Add note on supported build systems (#1323) ### What changes were proposed in this pull request? Add note on supported platforms in README. ### Why are the changes needed? Make it clearer to users what OSs are supported. ### Does this PR introduce _any_ user-facing change? N/A ### How was this patch tested? N/A --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index da3593ee65b..5357c09f796 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,13 @@ Gravitino is open source software available under the Apache 2.0 license. For in ## Online documentation -You can find the latest Gravitino documentation here in the [doc folder](docs), The README file only contains basic setup instructions. +You can find the latest Gravitino documentation in the [doc folder](docs). This README file only contains basic setup instructions. ## Building Gravitino -Gravitino builds Gradle. To build Gravitino, please run: +You can build Gravitino using Gradle. Currently you can build Gravitino on Linux and macOS, Windows isn't supported. + +To build Gravitino, please run: ```shell ./gradlew clean build -x test