From 4d32b660c67d71c2054dd22d88527df14a586d46 Mon Sep 17 00:00:00 2001
From: Rosemoe <2073412493@qq.com>
Date: Sun, 11 Feb 2024 18:37:53 +0800
Subject: [PATCH] add requirements section in getting-started page

---
 guide/getting-started.md | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/guide/getting-started.md b/guide/getting-started.md
index 4667521..f960d49 100644
--- a/guide/getting-started.md
+++ b/guide/getting-started.md
@@ -1,16 +1,41 @@
-# Get started
+# Getting Started
+## Requirements
+Before including [sora-editor](https://github.com/Rosemoe/sora-editor) library into your project, please ensure your environment and build configuration satify the requirements below:
+* Running Gradle on JDK 17 or above
+* The minimum Android SDK version of your module is at least Android L (API 21)
+  * If you are to use [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), the requirement will be at least Android O (API 26)
+* Project Java source compatibility and target compatibility is `JavaVersion.VERSION_17`
+::: details For Non-Gradle Build Systems
+
+The editor uses resources and is distributed in AAR files. Your build system must support processing AAR files.
+
+If you are not using Gradle as your build system, we won't provide information related to your build issues.
+
+:::
+## Add Dependencies
 Add to your app's dependencies:
 
 [![Maven Central](https://img.shields.io/maven-central/v/io.github.Rosemoe.sora-editor/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.Rosemoe.sora-editor%20editor))
 
-```groovy
+::: code-group
+
+```Kotlin [Kotlin DSL]
 dependencies {
     implementation(platform("io.github.Rosemoe.sora-editor:bom:<versionName>"))
     implementation("io.github.Rosemoe.sora-editor:<moduleName>")
 }
 ```
 
-## 🛠️Available modules:
+```Groovy [Groovy DSL]
+dependencies {
+    implementation platform("io.github.Rosemoe.sora-editor:bom:<versionName>")
+    implementation "io.github.Rosemoe.sora-editor:<moduleName>"
+}
+```
+
+:::
+
+### 🛠️Available modules
 
 | Module              | Summary                                                                                                                                                                                                                                                                                                                                                                                                           |
 | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |