Skip to content

Commit 4219439

Browse files
committed
Updated README
1 parent 1bf9f15 commit 4219439

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Icon Font to PNG
2-
[![Build Status](https://img.shields.io/travis/Pythonity/icon-font-to-png.svg)][if2p travis]
3-
[![PyPI Version](https://img.shields.io/pypi/v/icon_font_to_png.svg)][if2p pypi]
4-
[![Python Versions](https://img.shields.io/pypi/pyversions/icon_font_to_png.svg)][if2p pypi]
2+
[![Build Status](https://img.shields.io/travis/Pythonity/icon-font-to-png.svg)][travis]
3+
[![PyPI Version](https://img.shields.io/pypi/v/icon_font_to_png.svg)][pypi]
4+
[![Python Versions](https://img.shields.io/pypi/pyversions/icon_font_to_png.svg)][pypi]
55
[![License](https://img.shields.io/github/license/Pythonity/icon-font-to-png.svg)][license]
66

77
Python script (and library) for easy and simple export of icons from web
@@ -15,20 +15,20 @@ with the [first][odyniec fa2p] iteration of the concept.
1515
## Installation
1616
Make sure you have required packages for [Pillow installation][pillow].
1717

18-
With `PyPI` (recommended):
18+
From PyPI (recommended):
1919
```
2020
$ pip install icon_font_to_png
2121
```
2222

2323
With `git clone`:
24-
```
24+
```shell
2525
$ git clone https://github.com/Pythonity/icon-font-to-png
2626
$ pip install -r icon-font-to-png/requirements.txt
2727
$ cd icon-font-to-png/bin
2828
```
2929

3030
### OS X
31-
As reported [here][if2p osx], to install it on OS X:
31+
As reported [here][if2p osx bug], to install it on OS X:
3232
```
3333
$ pip install icon_font_to_png --ignore-installed six
3434
```
@@ -107,16 +107,19 @@ But feel free to ask [me](mailto:pawel.adamczak@sidnet.info) if anything
107107
is unclear.
108108

109109
## Tests
110-
Package was tested with `pytest` and `tox` on Python 2.7 and 3.4
111-
(see `tox.ini`).
110+
Package was tested with the help of `py.test` and `tox` on Python 2.7, 3.4
111+
and 3.5 (see `tox.ini`).
112112

113-
To run tests yourself run `tox` inside the repository.
113+
To run tests yourself run `tox` inside the repository:
114+
```
115+
$ tox
116+
```
114117

115118
## Contributions
116-
Package source code is available at [GitHub][if2p github].
119+
Package source code is available at [GitHub][github].
117120

118-
Feel free to use, ask, fork, star, report bugs, fix them, suggest
119-
enhancements and point out any mistakes.
121+
Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements,
122+
add functionality and point out any mistakes.
120123

121124
## Authors
122125
Developed and maintained by [Pythonity][pythonity].
@@ -125,13 +128,13 @@ Original version by [Michał Wojciechowski][odyniec], refactored by
125128
[Paweł Adamczak][pawelad].
126129

127130

128-
[if2p travis]: https://travis-ci.org/Pythonity/icon-font-to-png
129-
[if2p pypi]: https://pypi.python.org/pypi/icon_font_to_png
131+
[github]: https://github.com/Pythonity/icon-font-to-png
132+
[if2p osx bug]: https://github.com/Pythonity/icon-font-to-png/issues/2#issuecomment-197068427
130133
[license]: https://github.com/Pythonity/icon-font-to-png/blob/master/LICENSE
131134
[odyniec fa2p]: https://github.com/odyniec/font-awesome-to-png
135+
[odyniec]: https://github.com/odyniec
136+
[pawelad]: https://github.com/pawelad
132137
[pillow]: https://pillow.readthedocs.org/en/latest/installation.html
133-
[if2p osx]: https://github.com/Pythonity/icon-font-to-png/issues/2#issuecomment-197068427
134-
[if2p github]: https://github.com/Pythonity/icon-font-to-png
138+
[pypi]: https://pypi.python.org/pypi/icon_font_to_png
135139
[pythonity]: http://pythonity.com/
136-
[odyniec]: https://github.com/odyniec
137-
[pawelad]: https://github.com/pawelad
140+
[travis]: https://travis-ci.org/Pythonity/icon-font-to-png

0 commit comments

Comments
 (0)