Merge pull request #723 from mathquill/ci.cleanup

Major changes:
- throughout circle.yml, use the `json` cli tool
- fix the Sauce Connect retry-ing to only retry on failure rather than
  always
- on Sauce, use human-readable build name similar to on Circle; in
  particular, mention the CircleCI build number
- when applicable keep around pieces of screenshots in `imgs/pieces/`,
  and file away the baseline imgs (formerly the `PREV_*` imgs) in
  `imgs/baseline/`
- screenshot filename mentions version of browser used (which changes
  over time for evergreen browsers)
- `script/screenshots.js` now uses the "promise chain"-style of `wd`,
  much fewer callbacks

Also lots of minor improvements to comments, screenshots script error
logging, test names on Sauce, etc.
tree: 53e76a3b09082170c57795597cc5e2e39e4e69be
  1. .gitattributes
  2. .gitignore
  3. BUILDING
  4. CHANGELOG.md
  5. Makefile
  6. README.md
  7. circle.yml
  8. docs/
  9. mkdocs.yml
  10. package.json
  11. quickstart.html
  12. script/
  13. src/
  14. test/
README.md

MathQuill

by Han, Jeanine, and Mary (maintainers@mathquill.com)

MathQuill is a web formula editor designed to make typing math easy and beautiful.

The MathQuill project is supported by its partners. We hold ourselves to a compassionate Code of Conduct.

MathQuill is resuming active development and we‘re committed to getting things running smoothly. Find a dusty corner? Let us know in Slack. (Prefer IRC? We’re #mathquill on Freenode.)

Getting Started

MathQuill has a simple interface. This brief example creates a MathQuill element and renders, then reads a given input:

var htmlElement = document.getElementById('some_id');
var config = {
  handlers: { edit: function(){ ... } },
  restrictMismatchedBrackets: true
};
var mathField = MQ.MathField(htmlElement, config);

mathField.latex('2^{\\frac{3}{2}}'); // Renders the given LaTeX in the MathQuill field
mathField.latex(); // => '2^{\\frac{3}{2}}'

Check out our Getting Started Guide for setup instructions and basic MathQuill usage.

Docs

Most documentation for MathQuill is located on ReadTheDocs.

Some older documentation still exists on the Wiki.

Open-Source License

The Source Code Form of MathQuill is subject to the terms of the Mozilla Public License, v. 2.0: http://mozilla.org/MPL/2.0/

The quick-and-dirty is you can do whatever if modifications to MathQuill are in public GitHub forks. (Other ways to publicize modifications are also fine, as are private use modifications. See also: MPL 2.0 FAQ)