diff --git a/README.md b/README.md index 7809ac9fe..165b802e0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ +[![Build Status,](https://img.shields.io/travis/jsmaniac/scribble-math/master.svg)](https://travis-ci.org/jsmaniac/scribble-math) +[![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/scribble-math/master.svg)](https://coveralls.io/github/jsmaniac/scribble-math) +[![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/scribble-math) +[![Online Documentation.](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/scribble-math/) + scribble-math ============= -README text here. + +This library allows typesetting math and Asymptote figures in +[Scribble](https://docs.racket-lang.org/scribble/) documents. + +Installation +============ + +To install this package, use `raco`: + + raco pkg install scribble-math + +Documentation +============= + +See the [online documentation](http://docs.racket-lang.org/scribble-math/) +for more information about the math syntax and the +functionality of this library. + +Usage example +============= + +The syntax used for mathematical formulas is a subset of the +one used by LaTeX. + + #lang scribble/manual + + @require[scribble-math] + + @title[#:style (with-html5 manual-doc-style)]{Example} + + The derivative of @${x^2} is @${2x}. Complex formulas + look best when typeset in display mode: + + @$${\sum_{i=0}^n x_i^3} \ No newline at end of file diff --git a/scribblings/scribble-math.scrbl b/scribblings/scribble-math.scrbl index 71d149358..2c5372da1 100644 --- a/scribblings/scribble-math.scrbl +++ b/scribblings/scribble-math.scrbl @@ -24,7 +24,7 @@ @(use-mathjax) -@title[#:style (with-html5 manual-doc-style)]{scribble-math} +@title[#:style (with-html5 manual-doc-style)]{@racketmodname[scribble-math]} @author{georges} @defmodule[scribble-math]