Skip to content

Commit b978c23

Browse files
committed
Update README
1 parent c9fcf12 commit b978c23

File tree

3 files changed

+29856
-29850
lines changed

3 files changed

+29856
-29850
lines changed

README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,13 @@ See the examples for more information.
5353
Examples
5454
--------
5555

56-
To run the examples yourself, from the main directory, you first need to run:
56+
To run the examples yourself, from the main directory, you first need to run these commands in the specific order:
5757

5858
npm install lerna
59+
lerna exec npm install
5960
lerna bootstrap
6061

61-
This will install the development dependencies into your node_modules directory.
62+
This will bootstrap the packages in the current Lerna repo and install the development dependencies into your node_modules directory.
6263

6364
You can then start up the test server, as well as automatic source building, by doing:
6465

@@ -68,18 +69,24 @@ And now, for the magic, point your browser to:
6869

6970
http://localhost:3000/
7071

71-
From now on, if you change the source code for the examples, the examples bundle will be rebuilt and the browser will refresh itself. Errors will also be reported in the browser window.
72+
From now on, if you change the source code for the `examples` section, the examples bundle will be rebuilt and the browser will refresh itself. Errors will also be reported in the browser window.
7273

73-
Before committing back, run:
74+
If you want to change the `react-network-diagrams` code, you will need to run `npm run build` after working on your changes and then, the browser running the examples should reflect the changes.
75+
76+
For changes within the main library, run the following commands before committing the code:
7477

7578
npm run build
76-
npm run docs (if there's changes to the documentation)
77-
79+
npm run docs (if there's changes to the API documentation)
80+
81+
If there are changes to the website, run `npm run build` from the `packages/website` directory before merging to master.
82+
7883
Once this is done, you can make a pull request to merge this code into the master branch
7984

8085
Release Process
8186
--------
8287

88+
### Deploying a new version
89+
8390
Merge all the changes you want to deploy into the master branch.
8491

8592
Make sure to add release notes in [CHANGELOG.md](https://github.com/esnet/react-network-diagrams/blob/master/CHANGELOG.md)
@@ -91,3 +98,9 @@ Then, from the top level directory, run
9198
As part of this command, it will ask you the version number you want to pick.
9299

93100
Once that is selected, it will update the relevant package.json files and push code to github as well as deploy a new release to npm.
101+
102+
### Deploying the website
103+
104+
Currently, the website that hosts the examples and documentation can be found here - http://software.es.net/react-network-diagrams
105+
106+
This is being served via github pages, from the branch `gh-pages-latest`. Make sure to merge the latest code from master into this branch and it should automatically deploy the latest website.

0 commit comments

Comments
 (0)