Skip to content

Commit

Permalink
docs(project): improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julianpoemp committed Sep 23, 2023
1 parent f2a77a5 commit 49bea77
Showing 1 changed file with 99 additions and 9 deletions.
108 changes: 99 additions & 9 deletions libs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,105 @@

This sections shows an overview of all custom libraries used by OCTRA. All Angular-specific libraries start with "ngx".


- [utilities](./utilities/src/): library with custom functions used in the other libraries or apps like OCTRA (Browser, NodeJS)
- [media](./media/src/): all media related classes without dependencies to dom library (Browser, NodeJS).
- [web-media](./web-media/src/): all media related classes (for now audio only: audio playback a.s.o) (Browser)
- [assets](./assets/src/): library with shared assets in octra applications e.g. JSON schemata (Browser, NodeJS)
- [annotation](./annotation/src/): Objects and other classes used to handle annotation tasks (Browser, NodeJS)
- [ngx-components](./ngx-components/): Angular components e.g. for the signal displays.
- [ngx-utilities](./ngx-utilities/): library with custom functions used in angular projects
- [web-components](../apps/web-components/src/): library with web-components containing components from ngx-components. These components can be used in other frameworks or Vanilla JS. [See demo](../apps/web-components-demo/).
<table>
<thead>
<tr>
<th>Package</th>
<th>Compatibility</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="./utilities/src/">utilities</a>
</td>
<td>
Browser, NodeJS
</td>
<td>
library with custom functions used in the other libraries or apps like OCTRA
</td>
</tr>
<tr>
<td>
<a href="./media/src/">media</a>
</td>
<td>
Browser, NodeJS
</td>
<td>
all media related classes without dependencies to dom library
</td>
</tr>
<tr>
<td>
<a href="./web-media/src/">web-media</a>
</td>
<td>
Browser
</td>
<td>
all media related classes (for now audio only: audio playback a.s.o)
</td>
</tr>
<tr>
<td>
<a href="./assets/src/">assets</a>
</td>
<td>
Browser, NodeJS
</td>
<td>
library with shared assets in octra applications e.g. JSON schemata
</td>
</tr>
<tr>
<td>
<a href="./annotation/src/">annotation</a>
</td>
<td>
Browser, NodeJS
</td>
<td>
Objects and other classes used to handle annotation tasks
</td>
</tr>
<tr>
<td>
<a href="./ngx-components/src/">ngx-components</a>
</td>
<td>
Angular
</td>
<td>
Angular components e.g. for the signal displays
</td>
</tr>
<tr>
<td>
<a href="./ngx-utilities/src/">ngx-utilities</a>
</td>
<td>
Angular
</td>
<td>
library with custom functions used in angular projects
</td>
</tr>
<tr>
<td>
<a href="./web-components/src/">web-components</a>
</td>
<td>
Briwser
</td>
<td>
library with web-components containing components from ngx-components. These components can be used in other frameworks or Vanilla JS. <a href="../apps/web-components-demo/">See demo</a>.
</td>
</tr>
</tbody>
</table>

## API reference

Expand Down

0 comments on commit 49bea77

Please sign in to comment.