From cc2ccecc469ea4b2fe700877f1f9b54e90645a8e Mon Sep 17 00:00:00 2001
From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
Date: Fri, 13 Oct 2023 11:32:18 +0200
Subject: [PATCH] docs: update README

---
 README.md                       |  4 ++++
 projects/lit-ts/README.md       | 10 +++++-----
 projects/parcel-ts/README.md    |  8 ++++----
 projects/rollup-ts/README.md    | 17 +++++++----------
 projects/sveltekit-ts/README.md | 10 +++++-----
 projects/vitejs-ts/README.md    | 10 +++++-----
 6 files changed, 30 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 0e51333..6a49169 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,10 @@ nvm use
 
 If the Node version is not installed, `nvm` will state how to install the required version.
 
+Install dependencies by running
+```shell
+npm install
+```
 
 ### Available projects
 
diff --git a/projects/lit-ts/README.md b/projects/lit-ts/README.md
index df9257f..71db6cc 100644
--- a/projects/lit-ts/README.md
+++ b/projects/lit-ts/README.md
@@ -6,13 +6,13 @@ The application is built with [Vite](https://vitejs.dev/).
 
 ## Setup
 
-From the project root, run `npm install`.
+From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).
 
-If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
+If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.
 
 ## Running the project
 
-Run `npm run dev` and go to http://localhost:5173/
+From the repository root, run `npm run dev -w projects/lit-ts` and go to http://localhost:5173/
 
-If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
-bundle application.
+If you want to bundle the application, run `npm run build -w projects/lit-ts` and then run `npm run preview-w projects/lit-ts`
+to access to a preview of the bundled application.
diff --git a/projects/parcel-ts/README.md b/projects/parcel-ts/README.md
index 34982f8..a1cbec6 100644
--- a/projects/parcel-ts/README.md
+++ b/projects/parcel-ts/README.md
@@ -4,12 +4,12 @@ Parcel v2 is used in this TypeScript project: https://parceljs.org
 
 ## Setup
 
-From the project root, run `npm install`.
+From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).
 
-If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
+If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.
 
 ## Running the project
 
-Run `npm run dev` and go to http://localhost:1234/
+From the repository root, run `npm run dev -w projects/parcel-ts` and go to http://localhost:1234/
 
-If you want to bundle the application, run `npm run build`.
+If you want to bundle the application, run `npm run build -w projects/parcel-ts`.
diff --git a/projects/rollup-ts/README.md b/projects/rollup-ts/README.md
index 25f7221..1e8e71b 100644
--- a/projects/rollup-ts/README.md
+++ b/projects/rollup-ts/README.md
@@ -9,9 +9,9 @@ Adapted from https://github.com/typed-mxgraph/typed-mxgraph-example-bundled-with
 
 ### Setup
 
-From the project root, run `npm install`.
+From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).
 
-If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
+If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.
 
 ### Running the project
 
@@ -19,11 +19,8 @@ The `public/index.html` file contains a `<script src='bundle.js'>` tag, which me
 The `rollup.config.js` file tells Rollup how to create this bundle, starting with `src/main.ts` and including all its dependencies,
 including `mxGraph`.
 
-`npm run build` builds the application to `dist`, along with a sourcemap file for debugging.
-
-`npm start` launches a server, using [serve](https://github.com/zeit/serve). Navigate to http://localhost:3000/.
-
-`npm run watch` will continually rebuild the application as your source files change.
-
-`npm run dev` will run `npm start` and `npm run watch` in parallel.
-
+From the project root
+- `npm run build` builds the application to `dist`, along with a sourcemap file for debugging.
+- `npm start` launches a server, using [serve](https://github.com/zeit/serve). Navigate to http://localhost:3000/.
+- `npm run watch` will continually rebuild the application as your source files change.
+- `npm run dev` will run `npm start` and `npm run watch` in parallel.
diff --git a/projects/sveltekit-ts/README.md b/projects/sveltekit-ts/README.md
index babac52..412e00f 100644
--- a/projects/sveltekit-ts/README.md
+++ b/projects/sveltekit-ts/README.md
@@ -4,13 +4,13 @@ Initialized from [`create-svelte`](https://github.com/sveltejs/kit/tree/master/p
 
 ## Setup
 
-From the project root, run `npm install`.
+From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).
 
-If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
+If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.
 
 ## Running the project
 
-Run `npm run dev` and go to http://localhost:5173/
+From the repository root, run `npm run dev -w projects/sveltekit-ts` and go to http://localhost:5173/
 
-If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
-bundle application.
+If you want to bundle the application, run `npm run build -w projects/sveltekit-ts` and then run `npm run preview -w projects/sveltekit-ts`
+to access to a preview of the bundled application.
diff --git a/projects/vitejs-ts/README.md b/projects/vitejs-ts/README.md
index bd04cca..667a0de 100644
--- a/projects/vitejs-ts/README.md
+++ b/projects/vitejs-ts/README.md
@@ -4,13 +4,13 @@ Initialized from https://github.com/vitejs/vite/tree/v2.9.8/packages/create-vite
 
 ## Setup
 
-From the project root, run `npm install`.
+From the repository root, run `npm install`. For more details, see the [root README](../../README.md#setup).
 
-If you want to use the maxGraph development version (built locally), see the README about maxGraph integration.
+If you want to use the maxGraph development version (built locally), see the [root README](../../README.md#maxgraph-dev-version) about maxGraph integration.
 
 ## Running the project
 
-Run `npm run dev` and go to http://localhost:5173/
+From the repository root, run `npm run dev -w projects/vitejs-ts` and go to http://localhost:5173/
 
-If you want to bundle the application, run `npm run build` and then run `npm run preview` to access to a preview of the
-bundle application.
+If you want to bundle the application, run `npm run build -w projects/vitejs-ts` and then run `npm run preview -w projects/vitejs-ts`
+to access to a preview of the bundled application.