Skip to content

Commit f0f8cad

Browse files
committed
Added README.md
1 parent 93547ad commit f0f8cad

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Math
2+
3+
[![Latest Stable Version](https://poser.pugx.org/phpoffice/math/v/stable.png)](https://packagist.org/packages/phpoffice/math)
4+
[![Coverage Status](https://coveralls.io/repos/github/PHPOffice/Math/badge.svg?branch=master)](https://coveralls.io/github/PHPOffice/Math?branch=master)
5+
[![Total Downloads](https://poser.pugx.org/phpoffice/math/downloads.png)](https://packagist.org/packages/phpoffice/math)
6+
[![License](https://poser.pugx.org/phpoffice/math/license.png)](https://packagist.org/packages/phpoffice/math)
7+
[![CI](https://github.com/PHPOffice/Math/actions/workflows/php.yml/badge.svg)](https://github.com/PHPOffice/Math/actions/workflows/php.yml)
8+
9+
Math is a library written in pure PHP that provides a set of classes to manipulate different formula file formats, i.e. [MathML](https://en.wikipedia.org/wiki/MathML) and [Office MathML (OOML)](https://en.wikipedia.org/wiki/Office_Open_XML_file_formats#Office_MathML_(OMML)).
10+
11+
Math is an open source project licensed under the terms of [MIT](https://github.com/PHPOffice/Math/blob/master/LICENCE). Math is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/Math/actions/workflows/php.yml). You can learn more about Math by reading this Developers'Documentation and the [API Documentation](http://phpoffice.github.io/Math/docs/)
12+
13+
If you have any questions, please ask on [StackOverFlow](https://stackoverflow.com/questions/tagged/phpoffice-math)
14+
15+
Read more about Math:
16+
17+
- [Features](#features)
18+
- [Requirements](#requirements)
19+
- [Installation](#installation)
20+
- [Contributing](#contributing)
21+
- [Developers' Documentation](https://phpoffice.github.io/Math/)
22+
23+
## Features
24+
25+
- Insert elements:
26+
27+
* Basic :
28+
29+
* Identifier : <math display="inline"><mi>a</mi></math>
30+
* Operator : <math display="inline"><mo>+</mo></math>
31+
* Numeric : <math display="inline"><mn>2</mn></math>
32+
33+
* Simple :
34+
35+
* Fraction : <math display="inline"><mfrac><mi>a</mi><mn>3</mn></mfrac></math>
36+
* Superscript : <math display="inline"><msup><mi>a</mi><mn>3</mn></msup></math>
37+
38+
* Architectural :
39+
40+
* Row
41+
* Semantics
42+
43+
- Support
44+
45+
* MathML
46+
* OfficeMathML
47+
## Requirements
48+
49+
Math requires the following:
50+
51+
- PHP 7.1+
52+
- [XML Parser extension](http://www.php.net/manual/en/xml.installation.php)
53+
- [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php)
54+
55+
## Installation
56+
57+
Math is installed via [Composer](https://getcomposer.org/).
58+
To [add a dependency](https://getcomposer.org/doc/04-schema.md#package-links) to Math in your project, either
59+
60+
Run the following to use the latest stable version
61+
```sh
62+
composer require phpoffice/math
63+
```
64+
or if you want the latest unreleased version
65+
```sh
66+
composer require phpoffice/math:dev-master
67+
```
68+
69+
## Contributing
70+
71+
We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute.
72+
73+
- [Fork us](https://github.com/PHPOffice/Math/fork) and [request a pull](https://github.com/PHPOffice/Math/pulls) to the [master](https://github.com/PHPOffice/Math/tree/master) branch.
74+
- Submit [bug reports or feature requests](https://github.com/PHPOffice/Math/issues) to GitHub.
75+
- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Math is a library written in pure PHP that provides a set of classes to manipulate different formula file formats, i.e. [MathML](https://en.wikipedia.org/wiki/MathML) and [Office MathML (OOML)](https://en.wikipedia.org/wiki/Office_Open_XML_file_formats#Office_MathML_(OMML)).
44

5-
Math is an open source project licensed under the terms of [MIT](https://github.com/PHPOffice/PHPWord/blob/master/LICENCE). Math is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/Math/actions/workflows/php.yml). You can learn more about Math by reading this Developers'Documentation and the [API Documentation](http://phpoffice.github.io/PHPWord/docs/develop/)
5+
Math is an open source project licensed under the terms of [MIT](https://github.com/PHPOffice/Math/blob/master/LICENCE). Math is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/Math/actions/workflows/php.yml). You can learn more about Math by reading this Developers'Documentation and the [API Documentation](http://phpoffice.github.io/Math/docs/develop/)
66

77
## Features
88

0 commit comments

Comments
 (0)