Browse Source

update docs

master
Jonathan Cobb 3 years ago
parent
commit
3f1003c4f0
1 changed files with 4 additions and 4 deletions
  1. +4
    -4
      README.md

+ 4
- 4
README.md View File

@@ -63,6 +63,10 @@ whose properties are `assets` and `operations`.


When you run `jvcl` on a spec file, JVCL will read the `assets`, then perform the `operations` in order. When you run `jvcl` on a spec file, JVCL will read the `assets`, then perform the `operations` in order.


Unlike most JSON, comments *are* allowed in JVCL spec files:
* A line comment starts with `//` and continue to the end of the line (`// comment`)
* A multi-line block syntax starts with `/*` and ends with `*/` (`/* comment that may span multiple lines */`)

## Assets ## Assets
Assets are the inputs: generally image, audio and video files. Assets have a name and a path. Assets are the inputs: generally image, audio and video files. Assets have a name and a path.


@@ -119,10 +123,6 @@ Split an audio file according to silence
# Complex Example # Complex Example
Here is a complex example using multiple assets and operations. Here is a complex example using multiple assets and operations.


Note that in JVCL json files, comments are allowed:
* A line comment starts with `//` and continue to the end of the line (`// comment`)
* A multi-line block syntax starts with `/*` and ends with `*/` (`/* comment that may span multiple lines */`)

```json ```json
{ {
"assets": [ "assets": [


Loading…
Cancel
Save