Skip to content
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

Document installation and use of Grunt for Largo development #454

Closed
nrrb opened this issue Mar 25, 2015 · 2 comments
Closed

Document installation and use of Grunt for Largo development #454

nrrb opened this issue Mar 25, 2015 · 2 comments

Comments

@nrrb
Copy link

nrrb commented Mar 25, 2015

Grunt is used to run a few different tasks within Largo and there is no documentation on how to install it. For example, docs/readme.md explains how to use a grunt command to compile the RST docs into HTML.

@benlk explained to me that I needed to run npm install from the root of the Largo project folder, and after doing that I was able to use grunt for generating the documentation HTML. This instruction for npm install should appear somewhere and possible prerequisites for being able to use npm.

The tasks that Grunt performs should also be documented. @benlk said this includes:

  • recompiling the LESS to CSS
  • minifying the CSS
  • uglifying the JS
@benlk benlk modified the milestone: Write The Docs May 7, 2015
@benlk
Copy link
Collaborator

benlk commented Dec 23, 2015

Partially closed with #1036, for installing NPM. Still needs docs on what our Grunt tasks are and what they do.

@benlk
Copy link
Collaborator

benlk commented Jan 5, 2016

  • list of grunt tasks

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

No branches or pull requests

2 participants