Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
altavir committed Jul 29, 2023
1 parent d5ebef4 commit 3806f97
Show file tree
Hide file tree
Showing 8 changed files with 265 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[![JetBrains Research](https://jb.gg/badges/research.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[![DOI](https://zenodo.org/badge/148831678.svg)](https://zenodo.org/badge/latestdoi/148831678)

![Gradle build](https://github.com/mipt-npm/dataforge-core/workflows/Gradle%20build/badge.svg)


### [dataforge-context](dataforge-context)
>
>
> **Maturity**: DEVELOPMENT
### [dataforge-data](dataforge-data)
>
>
> **Maturity**: EXPERIMENTAL
### [dataforge-io](dataforge-io)
>
>
> **Maturity**: PROTOTYPE
### [dataforge-meta](dataforge-meta)
>
>
> **Maturity**: DEVELOPMENT
### [dataforge-scripting](dataforge-scripting)
>
>
> **Maturity**: PROTOTYPE
### [dataforge-workspace](dataforge-workspace)
>
>
> **Maturity**: EXPERIMENTAL
### [dataforge-io/dataforge-io-yaml](dataforge-io/dataforge-io-yaml)
> YAML meta converters and Front Matter envelope format
>
> **Maturity**: PROTOTYPE
32 changes: 32 additions & 0 deletions dataforge-context/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-context

Context and provider definitions

## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-context:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-context:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-context:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-data



## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-data:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-data:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-data:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-io/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-io

IO module

## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-io:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-io:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-io:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-io/dataforge-io-yaml/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-io-yaml

YAML meta IO

## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-io-yaml:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-io-yaml:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-io-yaml:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-meta/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-meta

Meta definition and basic operations on meta

## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-meta:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-meta:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-meta:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-scripting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-scripting



## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-scripting:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-scripting:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-scripting:0.6.2-dev-2")
}
```
32 changes: 32 additions & 0 deletions dataforge-workspace/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Module dataforge-workspace



## Usage

## Artifact:

The Maven coordinates of this project are `space.kscience:dataforge-workspace:0.6.2-dev-2`.

**Gradle Groovy:**
```groovy
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
}
dependencies {
implementation 'space.kscience:dataforge-workspace:0.6.2-dev-2'
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}

dependencies {
implementation("space.kscience:dataforge-workspace:0.6.2-dev-2")
}
```

0 comments on commit 3806f97

Please sign in to comment.