MathJax-grunt-cleaner icon indicating copy to clipboard operation
MathJax-grunt-cleaner copied to clipboard

Explain how this is supposed to be used

Open pv opened this issue 8 years ago • 2 comments

Please include a full example in README.md on how this is supposed to be used, for someone not familiar with nodejs.

In the infinite time limit, I can figure it out, but basically listing set of the commands required would be a big help. For example, the following is not the right thing to do apparently:

git clone https://github.com/mathjax/MathJax-grunt-cleaner.git
cd MathJax-grunt-cleaner
wget https://github.com/mathjax/MathJax/archive/master.zip && unzip master.zip
npm install grunt --save-dev grunt-contrib-clean grunt-regex-replace
grunt MML_SVG_TeX

EDIT: apparently, it's the Mathjax source tree top level should be copied to the directory where Gruntfile.js is...

pv avatar Apr 30 '17 17:04 pv

I have same problem as you, and I'm not very familiar with grunt, but I managed to make it work doing following:

git clone https://github.com/mathjax/MathJax-grunt-cleaner.git
cd MathJax-grunt-cleaner
wget https://github.com/mathjax/MathJax/archive/master.zip && unzip MathJax-master.zip
npm i grunt-cli -g
npm i
cp -r node_modules/ MathJax-master/
cp Gruntfile.js MathJax-master/
cd MathJax-master/
grunt MML_SVG_TeX
rm -r Gruntfile.js node_modules/

sebryu avatar May 05 '17 17:05 sebryu

Sorry, this fell of our radar.

This tool is meant as an example and was meant for Grunt users (such as the project this came from).

Besides the Gruntfile here, you can check our guide in the mathjax-docs wiki for the thinking behind this.

pkra avatar May 18 '17 13:05 pkra