Filled in README.md
This commit is contained in:
parent
19156d51fa
commit
8291f6b495
40
README.md
40
README.md
|
@ -1,3 +1,41 @@
|
||||||
|
[](https://travis-ci.org/jsmaniac/scribble-math)
|
||||||
|
[](https://coveralls.io/github/jsmaniac/scribble-math)
|
||||||
|
[](http://jsmaniac.github.io/travis-stats/#jsmaniac/scribble-math)
|
||||||
|
[](http://docs.racket-lang.org/scribble-math/)
|
||||||
|
|
||||||
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}
|
|
@ -24,7 +24,7 @@
|
||||||
|
|
||||||
@(use-mathjax)
|
@(use-mathjax)
|
||||||
|
|
||||||
@title[#:style (with-html5 manual-doc-style)]{scribble-math}
|
@title[#:style (with-html5 manual-doc-style)]{@racketmodname[scribble-math]}
|
||||||
@author{georges}
|
@author{georges}
|
||||||
|
|
||||||
@defmodule[scribble-math]
|
@defmodule[scribble-math]
|
||||||
|
|
Loading…
Reference in New Issue
Block a user