From 42d4fabf9050d57a22c45a7953afd48c80232ccc Mon Sep 17 00:00:00 2001 From: Anes Belfodil Date: Thu, 17 Sep 2020 10:11:31 -0400 Subject: [PATCH] Add requirements and workflow sections to readme --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3257b86a..b7cc91bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ -# Polydodo: Automatic Sleep Analysis Tool +# Polydodo: Automatic Sleep Analysis Tool -This projects aims to offer a comprehensive guide to **record polysomnographic EEG data from home** with an OpenBCI, a website to **upload sleep data** to our classifier and an **interactive visualisation** tool to observe the classified night of sleep. \ No newline at end of file +This projects aims to offer a comprehensive guide to **record polysomnographic EEG data from home** with an OpenBCI, a website to **upload sleep data** to our classifier and an **interactive visualisation** tool to observe the classified night of sleep. + +## Dev requirements + +### gRPC + +- Install `gRPC` package from your distribution's package manager +- Install `protoc` compiler + +### Yarn + +- Install Yarn package manager +- `yarn global add protoc-gen-grpc-web` +- Add `$HOME/.yarn/bin` to `PATH` + +### Python + +- Install Python 3 and pip +- Run `pip install -r requirements.txt` + +### Flutter + +- Install the latest stable version of flutter +- Run `flutter pub global activate protoc_plugin` +- Add `$HOME/.pub-cache/bin` to `PATH` + +### VS Code + +- Install VS Code +- Install the project's recommended extensions + +## Dev workflow + +- Open root folder on VS Code +- Install node modules by running `yarn install --cwd web` +- Fetch Flutter dependencies through the `Flutter` extension +- Compile all protos through `proto3` extension