From 2cc0338c0d54c5d38a5c2e5b01187912cb53f27b Mon Sep 17 00:00:00 2001
From: Patrizio Bekerle <patrizio@bekerle.com>
Date: Mon, 9 Nov 2020 13:05:41 +0100
Subject: [PATCH] Update install and build documentation (#36)

---
 packages/auth/README.md                           | 13 ++++++++-----
 packages/check-in-place-select/README.md          |  3 +++
 packages/data-table-view/README.md                | 15 +++++++++------
 packages/file-handling/README.md                  | 15 +++++++++------
 .../README.md                                     | 13 ++++++++-----
 packages/language-select/README.md                | 14 +++++++-------
 packages/matomo/README.md                         |  3 +++
 packages/notification/README.md                   | 15 +++++++++------
 packages/person-profile/README.md                 | 15 +++++++++------
 packages/person-select/README.md                  | 15 +++++++++------
 packages/qr-code-scanner/README.md                |  3 +++
 11 files changed, 77 insertions(+), 47 deletions(-)

diff --git a/packages/auth/README.md b/packages/auth/README.md
index 374bdab5..21480ed1 100644
--- a/packages/auth/README.md
+++ b/packages/auth/README.md
@@ -47,15 +47,18 @@
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/Auth.git
-cd Auth
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/auth
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch-local
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/check-in-place-select/README.md b/packages/check-in-place-select/README.md
index ba41dc31..5b6ac934 100644
--- a/packages/check-in-place-select/README.md
+++ b/packages/check-in-place-select/README.md
@@ -42,6 +42,9 @@ yarn run watch-local
 
 # run tests
 yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/data-table-view/README.md b/packages/data-table-view/README.md
index f09d8942..92d2637d 100644
--- a/packages/data-table-view/README.md
+++ b/packages/data-table-view/README.md
@@ -26,15 +26,18 @@
 # Local development
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/DataTableView.git
-cd DataTableView
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/data-table-view
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
-# constantly build dist/bundle.js and run a local web-server on port 8003
-npm run watch-local
+# constantly build dist/bundle.js and run a local web-server on port 8002 
+yarn run watch-local
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8003> and you should get a demo page.
diff --git a/packages/file-handling/README.md b/packages/file-handling/README.md
index ac909241..14cac2a9 100644
--- a/packages/file-handling/README.md
+++ b/packages/file-handling/README.md
@@ -88,16 +88,19 @@ files to a [Nextcloud](https://nextcloud.com/) instance.
 ## Local development
 
 ```bash
-# get the source code
-git clone git@gitlab.tugraz.at:dbp/web-components/FileHandling.git
-cd FileHandling
+# get the source
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/file-handling
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch-local
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a demo page.
diff --git a/packages/knowledge-base-web-page-element-view/README.md b/packages/knowledge-base-web-page-element-view/README.md
index 63cf5859..7b510b99 100644
--- a/packages/knowledge-base-web-page-element-view/README.md
+++ b/packages/knowledge-base-web-page-element-view/README.md
@@ -21,15 +21,18 @@
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/KnowledgeBaseWebPageElementView.git
-cd KnowledgeBaseWebPageElementView
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/knowledge-base-web-page-element-view
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch-local
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a demo page.
diff --git a/packages/language-select/README.md b/packages/language-select/README.md
index 43d9b8f1..b7688bbf 100644
--- a/packages/language-select/README.md
+++ b/packages/language-select/README.md
@@ -4,16 +4,16 @@
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/LanguageSelect.git
-cd LanguageSelect
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/language-select
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch-local
 
-# run tests
-npm test
+# build local packages in dist directory
+yarn run build
 ```
diff --git a/packages/matomo/README.md b/packages/matomo/README.md
index 4c90758b..eead62ef 100644
--- a/packages/matomo/README.md
+++ b/packages/matomo/README.md
@@ -48,6 +48,9 @@ yarn run watch
 
 # run tests
 yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a demo page.
diff --git a/packages/notification/README.md b/packages/notification/README.md
index 2a1d4d23..2218b8e8 100644
--- a/packages/notification/README.md
+++ b/packages/notification/README.md
@@ -28,18 +28,21 @@ send({
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/Notification.git
-cd Notification
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/notification
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch
 
 # run tests
-npm test
+yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a demo page.
diff --git a/packages/person-profile/README.md b/packages/person-profile/README.md
index b2cc2a5b..e63547ed 100644
--- a/packages/person-profile/README.md
+++ b/packages/person-profile/README.md
@@ -19,18 +19,21 @@
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/PersonProfile.git
-cd PersonProfile
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/person-profile
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch
 
 # run tests
-npm test
+yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/person-select/README.md b/packages/person-select/README.md
index 89b91156..21b33193 100644
--- a/packages/person-select/README.md
+++ b/packages/person-select/README.md
@@ -31,18 +31,21 @@
 
 ```bash
 # get the source
-git clone git@gitlab.tugraz.at:dbp/web-components/PersonSelect.git
-cd PersonSelect
+git clone git@gitlab.tugraz.at:dbp/web-components/toolkit.git
+cd toolkit/packages/person-select
 git submodule update --init
 
-# install dependencies (make sure you have npm version 4+ installed, so symlinks to the git submodules are created automatically)
-npm install
+# install dependencies
+yarn install
 
 # constantly build dist/bundle.js and run a local web-server on port 8002 
-npm run watch-local
+yarn run watch
 
 # run tests
-npm test
+yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a Single Sign On login page.
diff --git a/packages/qr-code-scanner/README.md b/packages/qr-code-scanner/README.md
index 28b0bdf7..95a2d72b 100644
--- a/packages/qr-code-scanner/README.md
+++ b/packages/qr-code-scanner/README.md
@@ -48,6 +48,9 @@ yarn run watch-local
 
 # run tests
 yarn test
+
+# build local packages in dist directory
+yarn run build
 ```
 
 Jump to <http://localhost:8002> and you should get a demo page.
-- 
GitLab