Skip to content

Commit

Permalink
Improve documentation on the targets. Improve publishing of RocksDB t…
Browse files Browse the repository at this point in the history
…argets.
  • Loading branch information
jurmous committed Jan 13, 2025
1 parent 8fc62ea commit 750ebc6
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

# Maryk: Cross-Platform Data Modeling and Storage

Maryk is a **Kotlin Multiplatform** framework for defining, validating, serializing, and storing data models consistently across multiple platforms, including iOS, macOS, Linux, Windows, Android, JVM, and JavaScript. With a fully version-aware data store and flexible querying, Maryk makes it easy to maintain complex data structures while ensuring backward compatibility and efficient data handling.
Maryk is a **Kotlin Multiplatform** framework for defining, validating, serializing, and storing data models consistently across multiple platforms, including **iOS**, **macOS**, **Linux**, **Windows**, **Android**, **JVM**, and **JavaScript**. With a fully version-aware data store and flexible querying, Maryk makes it easy to maintain complex data structures while ensuring backward compatibility and efficient data handling.

> **Note**: While Maryk’s data modeling and serialization are cross-platform, its persistant storage layer currently only runs on the JVM.
The RocksDB persistence layer is available for the **JVM**, **iOS**, **macOS**, **Android** and **Linux**.

## Key Features

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package maryk.conventions

/** conventions for a limited Kotlin/Native subproject */

plugins {
id("maryk.conventions.kotlin-multiplatform-base")
}

kotlin {
linuxX64()
linuxArm64()

iosArm64()
iosSimulatorArm64()
macosArm64()
macosX64()
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ kotlin {
// More specialised targets are disabled. They can be enabled, if there is demand for them - just make sure
// to add `dependsOn(nativeMain)` / `dependsOn(nativeTest)` below for any new targets.

linuxX64() // not supported by io.maryk.rocksdb:rocksdb-multiplatform
linuxArm64() // not supported by kotlinx-datetime
linuxX64()
linuxArm64()

mingwX64() // not supported by io.maryk.rocksdb:rocksdb-multiplatform

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ val sonatypeReleaseUrl = isReleaseVersion.map { isRelease ->
}
//endregion


//region POM convention
publishing {
publications.withType<MavenPublication>().configureEach {
Expand Down
5 changes: 0 additions & 5 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ Maryk Library is a project that provides multi-platform implementations for esse
used across Maryk projects. The purpose of this library is to abstract platform-specific
functionality, ensuring that all core Maryk projects have consistent support for the various platforms it supports.

## Platform Support

At present, Maryk Library provides support for JavaScript (JS), Android,
Java Virtual Machine (JVM) and Kotlin/Native with iOS and macOS targets.

## Dependency

The foundation of Maryk projects is the Kotlin Standard Library, which means that as
Expand Down
8 changes: 1 addition & 7 deletions store/rocksdb/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.TestExecutable

plugins {
id("maryk.conventions.kotlin-multiplatform-jvm")
id("maryk.conventions.kotlin-multiplatform-native-limited")
id("maryk.conventions.publishing")
}

Expand All @@ -26,13 +27,6 @@ kotlin {
}
}
}

macosArm64()
macosX64()
iosArm64()
iosSimulatorArm64()
linuxX64()
linuxArm64()
}

fun Task.configureTestDatabase() {
Expand Down

0 comments on commit 750ebc6

Please sign in to comment.