Skip to content

Commit

Permalink
Fix OSS documentation
Browse files Browse the repository at this point in the history
Summary: The documentation incorrectly pointed to the location of the vrs and vrsplayer tools in the cmake OSS builds.

Reviewed By: kiminoue7

Differential Revision: D51714072

fbshipit-source-id: e09d9c08fbab409637d12e2fe3cdde3a31b89bd8
  • Loading branch information
Georges Berenger authored and facebook-github-bot committed Nov 30, 2023
1 parent aee93be commit b619362
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,13 +207,14 @@ podman/docker run -it --volume <your_local_data>:/data vrs:latest
The `vrs` command line tool allows you to inspect and extract data out of VRS
files. It can create new VRS files by generating a modified copy of an original
recording. It can also extract images, dump metadata for human or computer
consumption (json). The vrs command line tool can be found at `tools/vrs`. It
has many options,
consumption (json). The vrs command line tool can be found in the cmake build
folder at `oss/tools/vrs/vrs`. It has many options,
[documented here](https://facebookresearch.github.io/vrs/docs/VrsCliTool).

`vrsplayer` is a GUI tool which can "play" VRS files as multi-stream video files
and audio files. It also provides ways to visualize record's metadata as they
are played. For more information, see the
are played. It can be found in the cmake build folder at
`oss/tools/vrsplayer/vrsplayer`. For more information, see the
[`vrsplayer` documentation](https://facebookresearch.github.io/vrs/docs/vrsplayer).

# Python interface
Expand Down

0 comments on commit b619362

Please sign in to comment.