Skip to content

Commit 2a1e6d9

Browse files
committed
doc: update index with more useful informations
1 parent 153f062 commit 2a1e6d9

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

docs/source/index.rst

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,31 @@ Welcome to Python MSS's documentation!
33

44
An ultra fast cross-platform multiple screenshots module in pure python using ctypes.
55

6-
Very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file, Python 2.6/3.5 compatible & :pep:`8` compliant.
7-
It could be easily embedded into games and other softwares which require fast and plateforme optimized methods to grab screenshots.
8-
9-
**MSS** stands for Multiple ScreenShots.
10-
11-
It's under MIT license.
12-
13-
Contents:
14-
15-
.. toctree::
16-
:maxdepth: 1
17-
18-
installation
19-
usage
20-
examples
21-
support
22-
api
23-
where
6+
- **Python 2.6/3.6** and :pep:`8` compliant, no dependency;
7+
- very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file;
8+
- but you can use PIL and benefit from all its formats (or add yours directly);
9+
- it could be easily embedded into games and other softwares which require fast and plateforme optimized methods to grab screenshots;
10+
- get the `source code on GitHub <https://github.com/BoboTiG/python-mss>`_;
11+
- and `report a bug <https://github.com/BoboTiG/python-mss/issues>`_;
12+
- **MSS** stands for Multiple ScreenShots;
13+
- insanely fast, did I said it?
14+
15+
+-------------------------+
16+
| Content |
17+
+-------------------------+
18+
|.. toctree:: |
19+
| :maxdepth: 1 |
20+
| |
21+
| installation |
22+
| usage |
23+
| examples |
24+
| support |
25+
| api |
26+
| where |
27+
+-------------------------+
2428

2529
Indices and tables
2630
==================
2731

2832
* :ref:`genindex`
2933
* :ref:`search`
30-

0 commit comments

Comments
 (0)