Skip to content
This repository has been archived by the owner on Aug 5, 2021. It is now read-only.

Commit

Permalink
allow samples subdirectory to be elided if empty (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrevels authored Jun 17, 2020
1 parent 2faa2bd commit 73ac613
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Onda** is a lightweight format for storing and manipulating sets of multi-sensor, multi-channel, LPCM-encodable, annotated, time-series recordings.

The latest tagged version is [v0.3.0](https://github.com/beacon-biosignals/OndaFormat/tree/v0.3.0).
The latest tagged version is [v0.4.0](https://github.com/beacon-biosignals/OndaFormat/tree/v0.4.0).

This document contains:

Expand Down Expand Up @@ -71,7 +71,7 @@ This specification document is versioned in accordance with [semantic versioning

An Onda dataset is comprised entirely of a filesystem directory and that directory's contents. The directory's name may (but is not required to) have the extension `.onda` to signify that the directory is an Onda dataset.

An Onda dataset directory may contain any user-authored content, but **must** contain the following files/subdirectories:
An Onda dataset directory may contain any user-authored content, but **must** contain the following files/subdirectories (note, though, that the `samples` subdirectory may be elided if it is empty):

```
dataset_name.onda/
Expand All @@ -84,7 +84,7 @@ Each of the above files/subdirectories is described in detail later, but here's

- `recordings.msgpack.zst`: a [zstd](https://github.com/facebook/zstd)-compressed [MessagePack](https://msgpack.org/index.html) file which contains a map whose entries represent individual recordings in the dataset.

- `samples/`: a directory containing all sample data associated with the dataset, grouped into subdirectories for each recording.
- `samples/`: a subdirectory containing all sample data associated with the dataset, grouped into subdirectories for each recording. This subdirectory need not exist if it would be empty.

- ``: any additional content as provided by the dataset author.

Expand Down

0 comments on commit 73ac613

Please sign in to comment.