From ae126d36c86eb5a2606432e9feec29d3a81bca5a Mon Sep 17 00:00:00 2001
From: Iaroslav Postovalov <postovalovya@gmail.com>
Date: Wed, 6 Jan 2021 21:06:57 +0700
Subject: [PATCH] Update readmes for Complex, minor update of build-script

---
 README.md                             | 11 +++++++
 kmath-complex/README.md               | 45 +++++++++++++++++++++++++++
 kmath-complex/build.gradle.kts        |  8 +++--
 kmath-complex/docs/README-TEMPLATE.md |  7 +++++
 kmath-core/build.gradle.kts           |  4 ++-
 5 files changed, 71 insertions(+), 4 deletions(-)
 create mode 100644 kmath-complex/README.md
 create mode 100644 kmath-complex/docs/README-TEMPLATE.md

diff --git a/README.md b/README.md
index 0899f77cc..ab665985f 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,17 @@ submit a feature request if you want something to be implemented first.
 > **Maturity**: EXPERIMENTAL
 <hr/>
 
+* ### [kmath-complex](kmath-complex)
+> Complex numbers and quaternions.
+>
+> **Maturity**: DEVELOPMENT
+>
+> **Features:**
+> - [complex](kmath-complex/src/commonMain/kotlin/kscience/kmath/complex/Complex.kt) : Complex Numbers
+> - [quaternion](kmath-complex/src/commonMain/kotlin/kscience/kmath/complex/Quaternion.kt) : Quaternions
+
+<hr/>
+
 * ### [kmath-core](kmath-core)
 > Core classes, algebra definitions, basic linear algebra
 >
diff --git a/kmath-complex/README.md b/kmath-complex/README.md
new file mode 100644
index 000000000..39efea161
--- /dev/null
+++ b/kmath-complex/README.md
@@ -0,0 +1,45 @@
+# The Core Module (`kmath-core`)
+
+Complex and hypercomplex number systems in KMath:
+
+ - [complex](src/commonMain/kotlin/kscience/kmath/complex/Complex.kt) : Complex Numbers
+ - [quaternion](src/commonMain/kotlin/kscience/kmath/complex/Quaternion.kt) : Quaternions
+
+
+> #### Artifact:
+>
+> This module artifact: `kscience.kmath:kmath-complex:0.2.0-dev-4`.
+>
+> Bintray release version:        [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-complex/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-complex/_latestVersion)
+>
+> Bintray development version:    [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-complex/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-complex/_latestVersion)
+>
+> **Gradle:**
+>
+> ```gradle
+> repositories {
+>     maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
+>     maven { url 'https://dl.bintray.com/mipt-npm/kscience' }
+>     maven { url 'https://dl.bintray.com/mipt-npm/dev' }
+>     maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
+> 
+> }
+> 
+> dependencies {
+>     implementation 'kscience.kmath:kmath-complex:0.2.0-dev-4'
+> }
+> ```
+> **Gradle Kotlin DSL:**
+>
+> ```kotlin
+> repositories {
+>     maven("https://dl.bintray.com/kotlin/kotlin-eap")
+>     maven("https://dl.bintray.com/mipt-npm/kscience")
+>     maven("https://dl.bintray.com/mipt-npm/dev")
+>     maven("https://dl.bintray.com/hotkeytlt/maven")
+> }
+> 
+> dependencies {
+>     implementation("kscience.kmath:kmath-complex:0.2.0-dev-4")
+> }
+> ```
diff --git a/kmath-complex/build.gradle.kts b/kmath-complex/build.gradle.kts
index c988ee038..055c39225 100644
--- a/kmath-complex/build.gradle.kts
+++ b/kmath-complex/build.gradle.kts
@@ -1,3 +1,5 @@
+import ru.mipt.npm.gradle.Maturity
+
 plugins {
     id("ru.mipt.npm.mpp")
     id("ru.mipt.npm.native")
@@ -11,18 +13,18 @@ kotlin.sourceSets.commonMain {
 
 readme {
     description = "Complex numbers and quaternions."
-    maturity = ru.mipt.npm.gradle.Maturity.DEVELOPMENT
+    maturity = Maturity.DEVELOPMENT
     propertyByTemplate("artifact", rootProject.file("docs/templates/ARTIFACT-TEMPLATE.md"))
 
     feature(
         id = "complex",
         description = "Complex Numbers",
-        ref = "src/commonMain/kotlin/kscience/kmath/operations/Algebra.kt"
+        ref = "src/commonMain/kotlin/kscience/kmath/complex/Complex.kt"
     )
 
     feature(
         id = "quaternion",
         description = "Quaternions",
-        ref = "src/commonMain/kotlin/kscience/kmath/structures/NDStructure.kt"
+        ref = "src/commonMain/kotlin/kscience/kmath/complex/Quaternion.kt"
     )
 }
diff --git a/kmath-complex/docs/README-TEMPLATE.md b/kmath-complex/docs/README-TEMPLATE.md
new file mode 100644
index 000000000..462fd617e
--- /dev/null
+++ b/kmath-complex/docs/README-TEMPLATE.md
@@ -0,0 +1,7 @@
+# The Core Module (`kmath-core`)
+
+Complex and hypercomplex number systems in KMath:
+
+${features}
+
+${artifact}
diff --git a/kmath-core/build.gradle.kts b/kmath-core/build.gradle.kts
index 8e2757f9a..757f9cd61 100644
--- a/kmath-core/build.gradle.kts
+++ b/kmath-core/build.gradle.kts
@@ -1,3 +1,5 @@
+import ru.mipt.npm.gradle.Maturity
+
 plugins {
     id("ru.mipt.npm.mpp")
     id("ru.mipt.npm.native")
@@ -19,7 +21,7 @@ kotlin.sourceSets {
 
 readme {
     description = "Core classes, algebra definitions, basic linear algebra"
-    maturity = ru.mipt.npm.gradle.Maturity.DEVELOPMENT
+    maturity = Maturity.DEVELOPMENT
     propertyByTemplate("artifact", rootProject.file("docs/templates/ARTIFACT-TEMPLATE.md"))
 
     feature(