diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-04-05 08:57:21 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-04-05 08:57:21 +0800 |
| commit | d76bc18bb7ccaa18f31df6e48722502e21610bdf (patch) | |
| tree | fdd1f63efb8fe50797f5ebb788ab6b35cbd41f30 /packages/website | |
| parent | 674e56cea69fe96ddd0071d3c4c5b5ea8ae299bf (diff) | |
| download | dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.gz dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.zst dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.zip | |
Improve contributing section of all packages so they include building entire monorepo on first contribution
Diffstat (limited to 'packages/website')
| -rw-r--r-- | packages/website/README.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/packages/website/README.md b/packages/website/README.md index 042df52de..0e23b02df 100644 --- a/packages/website/README.md +++ b/packages/website/README.md @@ -28,20 +28,24 @@ Add the following to your `/etc/hosts` file: yarn install ``` -### Run dev server +### Initial setup + +The **first** time you work with this package, you must build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory: ```bash -yarn run dev +yarn lerna:rebuild ``` -Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser. +### Run dev server -### Build +The the `website` root directory, run: ```bash -yarn build +yarn run dev ``` +Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser. + ### Clean ```bash |