Overhaul project setup

.editorconfig

@@ -0,0 +1,36 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = false
+max_line_length = 100
+tab_width = 4
+ij_continuation_indent_size = 8
+ij_any_line_comment_at_first_column = false
+ij_any_line_comment_add_space = true
+ij_smart_tabs = false
+ij_wrap_on_typing = false
+
+[plugin/Frecents/src/main/java/*.java]
+ij_formatter_enabled = false
+
+[*.{kt,kts}]
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false
+ktlint_code_style = ktlint_official
+ktlint_experimental = enabled
+ktlint_standard_no-wildcard-imports = disabled
+ktlint_standard_string-template-indent = disabled
+ktlint_standard_multiline-expression-wrapping = disabled
+ktlint_standard_function-expression-body = disabled
+ktlint_function_signature_body_expression_wrapping = default
+ktlint_chain_method_rule_force_multiline_when_chain_operator_count_greater_or_equal_than = 6
+ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 3
+ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 6
+
+[*.xml]
+ij_xml_continuation_indent_size = 4
+
+[*.yml]
+indent_size = 2

README.md

@@ -1,20 +1,38 @@
-# `Aliucord Plugin Repo Template`
+# Aliucord Plugin Repo Template
+
+---
 
 Template for an [Aliucord](https://github.com/Aliucord) plugin repo
 
-⚠️ Make sure you check "Include all branches" when using this template
+⚠️ Make sure you check "Include all branches" when using this template \
+⚠️ Consider getting familiar with Java and/or Kotlin and Gradle before starting
+
+## Pre-requisites
+
+- Java JDK 11 or newer. OpenJDK recommended
+- [Android Studio](https://developer.android.com/studio)
 
-
 ## Getting started with writing your first plugin
 
-This template includes 2 example plugins demonstrating commands and patches which you can find in the ExamplePlugins folder.
+This template includes an example plugin written in Kotlin and Java, demonstrating how to implement
+a command and patches.
+
+To set up your development environment:
+
+1. Clone this repository to your local machine.
+2. Open the cloned repository in Android Studio.
+3. Open the gradle build script at [plugin/build.gradle.kts](plugin/build.gradle.kts), read the
+   comments and replace all the placeholders
+4. Familiarize yourself with the project structure. Most files are commented
+
+To build and deploy your plugin:
 
-1. Open the root build.gradle.kts, read the comments and replace all the placeholders
-2. Familiarize yourself with the project structure. Most files are commented
-3. Build or deploy your first plugin using:
-   - Windows: `.\gradlew.bat MyFirstCommand:make` or `.\gradlew.bat MyFirstCommand:deployWithAdb`
-   - Linux & Mac: `./gradlew MyFirstCommand:make` or `./gradlew MyFirstCommand:deployWithAdb`
+- On Linux & Mac, run `./gradlew MyFirstKotlinPlugin:make` to build the plugin.
+  Use `./gradlew MyFirstKotlinPlugin:deployWithAdb` to deploy directly to a connected device.
+- On Windows, use `.\gradlew.bat MyFirstKotlinPlugin:make`
+  and `.\gradlew.bat MyFirstKotlinPlugin:deployWithAdb` for building and deploying, respectively.
 
 ## License
 
-Everything in this repo is released into the public domain. You may use it however you want with no conditions whatsoever
+Everything in this repo is released into the public domain. You may use it however you want with no
+conditions whatsoever