From 2dfef3f1251da2cc484e2095b8cd5a0ae53cf0aa Mon Sep 17 00:00:00 2001 From: Lou Klepner Date: Tue, 11 Jan 2022 17:33:55 -0500 Subject: [PATCH] added linking instructions --- DEVELOPING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/DEVELOPING.md b/DEVELOPING.md index 3718bc71d1..be81ad4f64 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -26,6 +26,28 @@ To run the examples you first need to start the dev server: Then, load in your browser. +## Linking Package + +The `ol` package is published from the `build/ol` folder of the `openlayers` repo. + +After you've cloned the `openlayers` repo locally run the `npm build-package` to prepare the build then use the `npm link` command to connect it your project. + +Below is an example of how to build and link it to "sample-project" + + + $ cd openlayers + $ npm build-package + $ cd build/ol + $ npm link + $ cd /sample-project + $ npm link ol + +To remove the link run the following commands + + $ cd sample-project + $ npm unlink --no-save ol + $ cd ../openlayers + $ npm unlink ## Running tests To run the tests once: