-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
49bea77
commit 0c99c0d
Showing
4 changed files
with
19 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
6 changes: 3 additions & 3 deletions
6
...s/src/lib/pipes/octra-utilities.module.ts → ...ilities/src/lib/octra-utilities.module.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters