An open API service indexing awesome lists of open source software.

https://github.com/xed-editor/browser


https://github.com/xed-editor/browser

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          

# Plugin Template for Xed-Editor

This project serves as a template for creating plugins for **Xed-Editor (Karbon)**.

## Setup

Follow these steps to set up the repository and build your plugin:

### 1. Clone the Repository

Start by cloning this repository and navigating into its directory:

```bash
git clone https://github.com/Xed-Editor/pluginTemplate
cd pluginTemplate
mkdir -p sdk
```

### 2. Download the SDK

1. Download the latest **`sdk.jar`** from the [GitHub actions](https://github.com/Xed-Editor/Xed-Editor-Sdk/actions).

**Note**: If certain APIs or Classes are not available in your plugin then just update the SDK jar.

2. Unzip it and Place the downloaded ** `sdk.jar`** file into the `app/libs` directory of the project

### 3. Build the Plugin

Run the following command to build your plugin:

```bash
bash gradlew assembleRelease
```

### 4. Locate the Build Output

After a successful build, your plugin will be available at:

```
app/build/outputs/apk/release/app-release-unsigned.apk
```

there should be a file with .apk extension this is your final file. you can install this from the app