From 3a92363e65a29b6106cdfa98d6bcf297b0eda5ad Mon Sep 17 00:00:00 2001
From: Allan Wang <me@allanwang.ca>
Date: Wed, 24 Jan 2018 23:44:49 -0500
Subject: Create buildSrc

---
 buildSrc/README.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 buildSrc/README.md

(limited to 'buildSrc/README.md')

diff --git a/buildSrc/README.md b/buildSrc/README.md
new file mode 100644
index 0000000..60d2dfc
--- /dev/null
+++ b/buildSrc/README.md
@@ -0,0 +1,92 @@
+# KAU :gradle-plugin
+
+> Plugin helper for KAU
+
+KAU holds quite a big collection of projects, with the intent on making it easy to reuse complex features, and also to update.
+This plugin aims to help maintain version updates straight from the source, and also adds on a few nice functions.
+
+As a note, this is located under `buildSrc` as it is automatically included when building KAU.
+Everything here is used when generating the library, so it's always tested.
+
+## Contents
+* [Versions](#versions)
+* [Plugins](#plugins)
+* [Dependencies](#dependencies)
+* [Changelog Generator](#changelog-generator)
+
+## Usage
+
+Firstly, add KAU to the buildscript:
+
+```gradle
+buildscript {
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
+
+    dependencies {
+        ...
+        classpath "ca.allanwang:kau:${KAU}"
+    }
+}
+```
+
+Then where necessary, apply the plugin using
+
+```gradle
+apply plugin: 'ca.allanwang.kau'
+```
+
+# Versions
+
+> [Versions.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Versions.groovy)
+
+Contains the version code for any external library used in KAU.
+You are free to use the values through `kau.[tagName]`.
+
+As an example, AppCompat is imported in KAU using
+
+```gradle
+api "com.android.support:appcompat-v7:${kau.supportLibs}"
+```
+
+# Plugins
+
+> [Plugins.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Plugins.groovy)
+
+Unfortunately, it seems like you can't use the plugin directly in the buildscript, so this is mainly internal.
+
+The plugins data, found using `kauPlugins.[tagName]` contains a collection of useful plugin classpaths.
+The versions are taken from `Versions.groovy`, so it is always in sync.
+
+# Dependencies
+
+> [Dependencies.groovy](/buildSrc/src/main/groovy/ca/allanwang/kau/Dependencies.groovy)
+
+Contains the dependency string for common libraries.
+You are free to use the values through `kauDependency.[tagName]`.
+
+As an example, adding junit can be done through
+
+```gradle
+testImplementation kauDependency.junit
+```
+
+# Changelog Generator
+
+In conjunction with [core](/core#changelog-xml), 
+the xml changelog can be converted to markdown.
+
+To allow for compilation per build, add your own task:
+
+```gradle
+task generateChangelogMd() {
+    kauChangelog.generate([inputPath], [outputPath])
+}
+```
+
+The wrapper allows for the generator to be called automatically with each build.
+
+
+
-- 
cgit v1.2.3