Commit ae84b32e authored by Samuel GAIST's avatar Samuel GAIST
Browse files

[doc][README] Update content for new setup

parent f29ab9d5
# 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`
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment