Skip to content

Commit

Permalink
add requirements section in getting-started page
Browse files Browse the repository at this point in the history
  • Loading branch information
Rosemoe committed Feb 11, 2024
1 parent 78c3abf commit 4d32b66
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -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 |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down

0 comments on commit 4d32b66

Please sign in to comment.