diff --git a/doc/README.md b/doc/README.md index ed4bafac40d1c5eb482daa9d95394dc9dc7882f4..b222ca5c8043948e031fba88f3dca38045ccb58c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,19 +1,22 @@ # beat.editor -A local editor for BEAT objects, including a graphical toolchain editor and a simple web server. Aims to compliment `beat.cmdline` to enable a productive and smooth workflow for developing objects for the BEAT platform as well as replace the current toolchain editor in `beat.web`. +A local editor for BEAT objects, including a graphical toolchain editor. It aims +to compliment `beat.cmdline` to enable a productive and smooth workflow for +developing objects for the BEAT platform as well as replace the current +toolchain editor in `beat.web`. ## Installation #### System Requirements -- Up-to-date version of [Node.js](https://nodejs.org/en/) -- Up-to-date version of [NPM](https://www.npmjs.com/) - - Installed by default alongside Node +- Up-to-date version of [conda](https://conda.io/miniconda.html) +- Idiap conda channel configured: :: + $ conda config --env --add channels https://www.idiap.ch/software/beat/conda -To install, just run `npm install`. +To install, just run `conda install beat.editor`. ### Use **TBD** ### Development -> See `DEV.md` +> See `contribute`