commit 231324c4e04d2cb29bff200caee8c88fb2a7265d
parent 9989811082d7f07a62bb5120fed85d97859dfe3d
Author: Davide P. Cervone <dpvc@union.edu>
Date: Mon, 7 Mar 2011 21:33:17 -0500
Update formatting, and fix references to docs
Diffstat:
| M | README.md | | | 44 | +++++++++++++++++++++++++------------------- |
1 file changed, 25 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -2,44 +2,50 @@
## Beautiful math in all browsers
-MathJax is an open-source JavaScript display engine for LaTeX and MathML that
-works in all modern browsers. It was designed with the goal of consolidating
-the recent advances in web technologies into a single, definitive,
-math-on-the-web platform supporting the major browsers and operating systems. It
-requires no setup on the part of the user (no plugins to download or software to
-install), so the page author can write web documents that include mathematics
-and be confident that users will be able to view it naturally and easily. Simply
-include MathJax and some mathematics in a web page, and MathJax does the rest.
+MathJax is an open-source JavaScript display engine for LaTeX and MathML
+that works in all modern browsers. It was designed with the goal of
+consolidating the recent advances in web technologies into a single,
+definitive, math-on-the-web platform supporting the major browsers and
+operating systems. It requires no setup on the part of the user (no
+plugins to download or software to install), so the page author can write
+web documents that include mathematics and be confident that users will be
+able to view it naturally and easily. Simply include MathJax and some
+mathematics in a web page, and MathJax does the rest.
Some of the main features of MathJax include:
- High-quality display of LaTeX and MathML math notation in HTML pages
-- Supported in most browsers with no plug-ins, extra fonts, or special setup for
- the reader
+
+- Supported in most browsers with no plug-ins, extra fonts, or special
+ setup for the reader
+
- Easy for authors, flexible for publishers, extensible for developers
-- Supports math accessibility, cut and paste interoperability and other advanced
- functionality
+
+- Supports math accessibility, cut-and-paste interoperability and other
+ advanced functionality
+
- Powerful API for integration with other web applications
See <http://www.mathjax.org/> for additional details.
+
## Installation and Usage
The MathJax installation and usage documentation is available in the
-`docs/build/html` directory of the MathJax distribution (see
-`docs/build/html/index.html` for the starting point). The documents are also
+`docs/html` directory of the MathJax distribution (see
+`docs/html/index.html` for the starting point). The documents are also
available on the MathJax web site on line at
-> <http://www.mathjax.org/docs/>
+> <http://www.mathjax.org/resources/docs/>
## Community
The main MathJax website is <http://www.mathjax.org>, and it includes
-announcements and other important information. MathJax is maintained and
-distributed on GitHub at <http://github.com/mathjax/MathJax>. A user forum for
-asking questions and getting assistance is hosted at Google, and the bug tracker
-is hosted at GitHub:
+announcements and other important information. MathJax is maintained and
+distributed on GitHub at <http://github.com/mathjax/MathJax>. A user forum
+for asking questions and getting assistance is hosted at Google, and the
+bug tracker is hosted at GitHub:
Bug tracker: <https://github.com/mathjax/MathJax/issues>
MathJax-Users Group: <http://groups.google.com/group/mathjax-users>