Skip to content

Commit 85def04

Browse files
committed
add instructions for using snapshot version
1 parent 6851978 commit 85def04

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

docs/guide/getting-started.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,29 @@ Check the table below to get more information about the modules.
127127
| language-textmate | An advanced highlighter for the editor. It can be used to load TextMate language bundles and themes. The internal implementation of TextMate is from [tm4e](https://github.com/eclipse/tm4e) |
128128
| language-treesitter | Offer [tree-sitter](https://tree-sitter.github.io/tree-sitter/) support for editor. This can be used to parse the code to an AST fast and incrementally, which is helpful for accurate highlighting and providing completions. Note that this module only provides incremental parsing and highlighting. Thanks to Java bindings [android-tree-sitter](https://github.com/AndroidIDEOfficial/android-tree-sitter/) |
129129

130+
### 🚧Snapshot Builds
131+
132+
Generally, it is recommended to use [released versions](https://github.com/Rosemoe/sora-editor/releases). But sometimes you may still want to use nightly builds for latest bug fixes and enhancements.
133+
134+
::: details How to Use Snapshot Builds
135+
136+
Snapshot versions are automatically published on repository push. You may combine current released version name
137+
and `-SNAPSHOT` to make a snapshot version name.
138+
139+
For example, if the latest released version name is `0.23.7`, you may use version name `0.23.7-SNAPSHOT` to import the snapshot version to your project.
140+
141+
Note that adding extra maven repository is required:
142+
```Kotlin{3}
143+
repositories {
144+
// ...
145+
maven("https://central.sonatype.com/repository/maven-snapshots")
146+
}
147+
```
148+
149+
Due to Central Portal limitations, the snapshot version is only kept for 90 days.
150+
151+
:::
152+
130153
## Configure Desugaring for TextMate
131154

132155
If you use `language-textmate` module in your project, and want to run the application on devices under Android 13 (API 33), you **must** enable [Core Library Desugaring](https://developer.android.google.cn/studio/write/java8-support#library-desugaring) to avoid compatibility issues. Otherwise, you can go on to next section.

docs/zh/guide/getting-started.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,27 @@ dependencies {
127127
| language-textmate | 一个高级的高亮分析库。你可以借助它来加载textmate语言配置文件并应用于本编辑器。 内部实现来自[tm4e](https://github.com/eclipse/tm4e)|
128128
| language-treesitter | 为编辑器提供[tree-sitter](https://tree-sitter.github.io/tree-sitter/)支持。tree-sitter可用于快速、增量地将代码转换 成抽象语法树,以便您向用户提供精确的高亮和自动补全功能。注意此模块仅提供了转换和高亮支持。感谢[android-tree-sitter](https://github.com/AndroidIDEOfficial/android-tree-sitter/)项目提供的Java绑定库。 |
129129

130+
### 🚧快照构建
131+
132+
通常情况下我们建议使用[正式发布的版本](https://github.com/Rosemoe/sora-editor/releases)。但有时候您可能需要使用最新的构建版本以取得最新的错误修复和功能更新。
133+
134+
::: details 如何使用快照构建
135+
136+
快照版本在存储库推送时自动发布。您可以将当前发布的版本名称和 `-SNAPSHOT` 组合在一起,得到快照版本名称。
137+
138+
举个例子, 如果目前最新正式发布的版本是 `0.23.7`,则可以将 `0.23.7-SNAPSHOT` 作为版本号导入快照版本到您的项目中。
139+
140+
需要注意的是,使用快照版本您需要额外添加一个maven存储库:
141+
```Kotlin{3}
142+
repositories {
143+
// ...
144+
maven("https://central.sonatype.com/repository/maven-snapshots")
145+
}
146+
```
147+
148+
由于 Central Portal 的限制,快照版本仅会保留 90 天。
149+
150+
:::
130151

131152
## 为TextMate配置脱糖
132153

0 commit comments

Comments
 (0)