Skip to content

Commit

Permalink
docs(readme): npm link caveat and solution and ref
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar authored Apr 8, 2022
1 parent 52e385a commit 8e2467e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ If you need to test file changes with [Core CMS] changes:
npm link @tacc/core-styles
```

_**Do** use `--save`.\* Do **not** commit the changes to `package.json` **nor** `package-lock.json`._

3. Re-install [Core Styles] dependency `postcss-cli`:

```bash
Expand All @@ -289,9 +291,10 @@ If you need to test file changes with [Core CMS] changes:
```

4. Make changes in your [Core Styles] clone as necessary.
5. Build changes.\*
5. Build changes.

<sub>\* See [How to Build Static Files](#how-to-build-static-files).</sub>
<sub>\* Use of `npm link` _without `--save`_ is overwritten by `npm install`. See [details](https://github.com/npm/cli/issues/2380#issuecomment-1029967927).</sub>\
<sub>† See [How to Build Static Files](#how-to-build-static-files).</sub>

#### Testing Core Styles Changes Remotely

Expand Down

0 comments on commit 8e2467e

Please sign in to comment.