Skip to content

docs: update build instructions in readme and contributing guide #3373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 21, 2018

Conversation

sis0k0
Copy link
Contributor

@sis0k0 sis0k0 commented Feb 16, 2018

The initial npm install in the repo is reporting errors because of the postinstall script, which expects that the 'ts' files are already transpiled. Maybe we should suggest running it with --ignore-scripts?
The other change is running grunt from the local installation of the package, because you may not have a global instance. Maybe the grunt invocation can be moved to a npm script?

@rosen-vladimirov
Copy link
Contributor

@sis0k0 we may add npm run setup script, which will execute npm install --ignore-scripts && npm run grunt? What do you think?

@sis0k0
Copy link
Contributor Author

sis0k0 commented Feb 19, 2018

@rosen-vladimirov, yep that makes sense. Should we include the git submodule init --update in the setup script as well?

@rosen-vladimirov
Copy link
Contributor

@sis0k0 sure, adding the command git submodule update --init makes sense for me

Copy link
Contributor

@rosen-vladimirov rosen-vladimirov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work!

@sis0k0 sis0k0 merged commit 27e937b into master Feb 21, 2018
@sis0k0 sis0k0 deleted the vlaeva/contributing-docs branch February 21, 2018 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants