From 93e44552b23cb16a06a9256e83d4dac6ac3a5e11 Mon Sep 17 00:00:00 2001 From: Samuel Gaist <samuel.gaist@idiap.ch> Date: Thu, 17 Jan 2019 10:09:17 +0100 Subject: [PATCH] [doc][readme] Add instructions to start the application --- doc/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index b222ca5c..10547634 100644 --- a/doc/README.md +++ b/doc/README.md @@ -14,9 +14,20 @@ toolchain editor in `beat.web`. To install, just run `conda install beat.editor`. + ### Use -**TBD** +To start the main beat.editor application: + + $ beat editor start + +This will show the main application Window which will allow to browse the prefix +configured or selected by the user. + +For more information about the options that can be used with the application: + + $ beat editor --help + ### Development > See `contribute` -- GitLab