diff --git a/doc/README.md b/doc/README.md index b222ca5c8043948e031fba88f3dca38045ccb58c..105476344bb9ce16286d8b961e03f7ef98edaf52 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`