Browse Source

Add new README

pull/78/head
Florian Mounier 11 years ago
parent
commit
32cb52a419
  1. 50
      README
  2. 1
      README.md
  3. 67
      README.md

50
README

@ -1,13 +1,51 @@
Pygal
=====
# Pygal
A python svg graph plotting library
@@TOC@@
License
-------
## Description
Copyright © 2012 Kozea
**pygal** is a dynamic SVG charting library written in python.
All the documentation is on http://pygal.org
## Installation
As simple as:
```
$ pip install pygal
```
## Test
Pygal is tested with py.test:
```
$ pip install pytest
$ py.test
```
## Contribute
You are welcomed to fork the project and make pull requests.
Be sure to create a branch for each feature, write tests if needed and run the current tests !
You can also support the project:
[![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=paradoxxx_zero&url=https://github.com/Kozea/pygal&title=Pygal&tags=github&category=software)
[![gittip](http://i.imgur.com/IKcQB2P.png)](https://www.gittip.com/paradoxxxzero/)
## License
Copyright © 2012-2013 Kozea
LGPLv3:
This program is free software: you can redistribute it and/or modify

1
README.md

@ -1 +0,0 @@
README

67
README.md

@ -0,0 +1,67 @@
# Pygal
- [Pygal](#pygal)
- [Description](#description)
- [Installation](#installation)
- [Test](#test)
- [Contribute](#contribute)
- [License](#license)
## Description
**pygal** is a dynamic SVG charting library written in python.
All the documentation is on http://pygal.org
## Installation
As simple as:
```
$ pip install pygal
```
## Test
Pygal is tested with py.test:
```
$ pip install pytest
$ py.test
```
## Contribute
You are welcomed to fork the project and make pull requests.
Be sure to create a branch for each feature, write tests if needed and run the current tests !
You can also support the project:
[![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=paradoxxx_zero&url=https://github.com/Kozea/pygal&title=Pygal&tags=github&category=software)
[![gittip](http://i.imgur.com/IKcQB2P.png)](https://www.gittip.com/paradoxxxzero/)
## License
Copyright © 2012-2013 Kozea
LGPLv3:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Loading…
Cancel
Save