Skip to content

Commit

Permalink
docs(project): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julianpoemp committed Sep 23, 2023
1 parent 49bea77 commit 0c99c0d
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 66 deletions.
4 changes: 2 additions & 2 deletions libs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Objects and other classes used to handle annotation tasks
</tr>
<tr>
<td>
<a href="./ngx-components/src/">ngx-components</a>
<a href="./ngx-components">ngx-components</a>
</td>
<td>
Angular
Expand All @@ -81,7 +81,7 @@ Angular components e.g. for the signal displays
</tr>
<tr>
<td>
<a href="./ngx-utilities/src/">ngx-utilities</a>
<a href="./ngx-utilities">ngx-utilities</a>
</td>
<td>
Angular
Expand Down
37 changes: 7 additions & 30 deletions libs/ngx-components/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,12 @@
# ngx-components

This library contains audio components for Angular used in Octra.
This library offers all annotation related classes and functions used by Octra. It uses AnnotJSON file format as base
model. Here you can also find all Annotation converters used by [Octra](https://github.com/IPS-LMU/octra).

## Installation

### ESM, CJS & TS definitions
Currently, the libraries are not published on npm because Octra 2.0 and the libraries are still in development. If you
want to use the libraries in your project you have to manually install.

1. Clone the OCTRA repository next to the project folder you want to use the libraries for.
2. Switch tu branch "static".

```shell
git checkout static
```

3. Now go to your project folder and run

```shell
npm install --legacy-peer-deps "../octra/libs/ngx-components"
```

### UMD Bundle (Vanilla JS)

See web-components library.

## Update

1. Go to the cloned octra repository. Make sure you are in branch `static`.
2. Update directory:

```shell
git pull
```
1. Install @octra/ngx-components with dependencies
````shell
npm install --save @octra/ngx-components
````
2. Add OctraComponentsModule to imports of your app.module.
38 changes: 7 additions & 31 deletions libs/ngx-utilities/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,11 @@
# ngx-utilities
# ngx-components

This library contains Angular specific functions.
This library angular related classes like pipes used by [Octra](https://github.com/IPS-LMU/octra).

## Installation

### ESM, CJS & TS definitions
Currently, the libraries are not published on npm because Octra 2.0 and the libraries are still in development. If you
want to use the libraries in your project you have to manually install.

1. Clone the OCTRA repository next to the project folder you want to use the libraries for.
2. Switch tu branch "static".

```shell
git checkout static
```

3. Now go to your project folder and run

```shell
npm install --legacy-peer-deps "../octra/libs/ngx-utilities"
```

### UMD Bundle (Vanilla JS)

Not available.

## Update

1. Go to the cloned octra repository. Make sure you are in branch `static`.
2. Update directory:

```shell
git pull
```
1. Install @octra/ngx-utilities with dependencies
````shell
npm install --save @octra/ngx-utilities
````
2. Add OctraUtilitiesModule to imports of your app.module.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
import { TimespanPipe } from './timespan.pipe';
import { LeadingNullPipe } from './leadingnull.pipe';
import { ProcentPipe } from './procent.pipe';
import { TimespanPipe } from './pipes/timespan.pipe';
import { LeadingNullPipe } from './pipes/leadingnull.pipe';
import { ProcentPipe } from './pipes/procent.pipe';

@NgModule({
declarations: [TimespanPipe, LeadingNullPipe, ProcentPipe],
Expand Down

0 comments on commit 0c99c0d

Please sign in to comment.