Skip to content
This repository has been archived by the owner on May 22, 2020. It is now read-only.

Usage section of readme doesn't describe usage. #5

Open
leonaves opened this issue Feb 17, 2019 · 1 comment
Open

Usage section of readme doesn't describe usage. #5

leonaves opened this issue Feb 17, 2019 · 1 comment

Comments

@leonaves
Copy link

leonaves commented Feb 17, 2019

There's a usage section in the readme but it doesn't actually say what to do other than yarn install. There's no start script, what is the user supposed to be running? There's a gulpfile, what is that for? Does the user have to run gulp before anything else? Or just yarn install?

@arcanis
Copy link
Member

arcanis commented Feb 17, 2019

As mentioned in the readme:

This app showcase a wide range of popular packages, and show that Plug'n'play has no issue working with them.

So basically, pretty much all those scripts are just typical tools that you'd find in a regular app. Running gulp will build the webapp, running yarn webpack as well, running yarn serve will serve the app on the port 8080, running yarn rollup will build a library exposing fibonnacci, etc ...

The only piece that matters is yarn install, really :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants