Added new READMEs connected to monorepo migration

mudita · Feb 9, 2021 · d7d98f3 · d7d98f3
1 parent 3e900d8
commit d7d98f3
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/packages/app/README.md b/packages/app/README.md
@@ -1 +1,2 @@
-# Mudita Center - App
+# Mudita Center - main app
+This repo contains the main Mudita Center app.
diff --git a/packages/design-system/README.md b/packages/design-system/README.md
@@ -1 +1,2 @@
-# Mudita Center - design-system
+# Mudita Center - design-system
+This repo will contain Mudita Center design components.
diff --git a/packages/pure/README.md b/packages/pure/README.md
@@ -1,3 +1,9 @@
+# Mudita Center - Pure library
+
+This library enables communication with Mudita Pure phone(s) through a serial port. Communication can happen one-way (request) or both ways (event). The library's client decides on the way of processing the data with the phone.
+
+This library also enables communicating with the Pure phone using the terminal.
+
 ## Setup
 
 ### Install

diff --git a/quickstart.md b/quickstart.md
@@ -4,6 +4,8 @@ To follow these instructions you need to have [Node.js](https://nodejs.org) inst
 
 **Note:** Mudita Center utilizes Node.js and npm versions [specified in `package.json` file](package.json#L264). To downgrade your currently installed version of Node.js please use [Node Version Manager](https://github.com/nvm-sh/nvm).
 
+**Note:** Mudita Center utilizes [Lerna](https://github.com/lerna/lerna) for managing packages contained in this repository. Lerna installs the main packages and links internal dependencies. The project has been set up in a way which enables running test and linters for every package separately.
+
 ## Install packages
 
 After cloning the repository to your local environment please install all packages by typing:
@@ -35,7 +37,11 @@ Please run the following command to start the Mudita Center dev environment:
 npm run develop
 ```
 
-This will start the application with hot-reload so you can instantly start developing it.
+This will start the application with hot-reload so you can instantly start developing it. You can also enable logs by executing:
+
+```bash
+npm run develop — --stream
+```
 
 This command runs the User Interface and the backend simultaneously, however, if you wish to have logs from both processes in two separate consoles then please run the following commands in parallel in separate console tabs: