projectstorm / react-diagrams

a super simple, no-nonsense diagramming library written in react that just works

https://projectstorm.cloud/react-diagrams

MIT License

8.46k stars 1.16k forks source link

Update README.md with improved instructions for running the demos #891

Closed parties closed 2 years ago

parties commented 2 years ago

Update the Run the demos section with additional instructions to get the demos running

Checklist

Do I need to do all of this for just a README edit?

[ ] The code has been run through pretty yarn run pretty
[ ] The tests pass on CircleCI
[ ] You have referenced the issue(s) or other PR(s) this fixes/relates-to
[x] The PR Template has been filled out (see below)
[x] ~~Had a beer/coffee because you are awesome~~ I had a sandwich

What?

The instructions for running the demos was incomplete and the demos cannot be run if you follow the instructions exactly.

Why?

There was a missing step: yarn run build.

How?

I updated the README with the missing instruction to build the project first before running the demo code.

Feel good image:

danielbarion commented 2 years ago

Thank you!