Skip to content

Commit

Permalink
[docs] Clarify on how to use the local distribution in the CONTRIBUTI…
Browse files Browse the repository at this point in the history
…NG file (#13312)

In this commit, we are clarifying how to install the local distribution 
of Material-UI to test changes on a real case scenario.

It turns out that, if you don't point the instalation to the /build 
folder, when importing a Material-UI component, the path 
"@material-ui/core/<ComponentName>" does not work.

It took me a while to realize how to install the local distribution, 
that's why I decided to update the documentation.
  • Loading branch information
nicolasiensen authored and oliviertassinari committed Oct 20, 2018
1 parent 1f8d526 commit c26a0c8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Then, you can add Material-UI to any project you want to try your changes:

```shell
# From the root folder of any project
yarn add file:/path/to/material-ui/folder
yarn add file:<path-to-material-ui-project>/packages/material-ui/build
```

Now, every time you import `material-ui` in your project, it is going to use your local distribution.
Expand Down

0 comments on commit c26a0c8

Please sign in to comment.