Adam Turner
55eddad705
Use proper Pygments lexers
2024-07-24 15:21:25 +01:00
Dimitri Papadopoulos Orfanos
68295a5a78
[docs] Remove duplicate "the" from README file ( #11835 )
2024-01-01 15:39:09 +01:00
Adam Turner
f5aadc1c3f
Remove "Release signatures" section of the README
...
PyPI has stopped supporting signed releases.
https://blog.pypi.org/posts/2023-05-23-removing-pgp/
2023-07-23 23:17:46 +01:00
Adam Turner
d4fc9f6bd0
Add GPG key for Adam Turner
2022-07-17 23:03:38 +01:00
Adam Turner
14d669945b
Capitalise "EPUB"
...
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
2022-06-06 16:27:32 +01:00
Adam Turner
3b760d393e
Move release badge first, remove download stats
2022-06-03 00:22:00 +01:00
Adam Turner
a74755dbc7
Reformat the introduction and features list
2022-06-03 00:14:31 +01:00
Adam Turner
54acdc613c
Simplify the Installation section
2022-06-02 23:38:25 +01:00
Adam Turner
7a7c811ed2
Condense into a single "Contributing" section
2022-06-02 23:29:58 +01:00
Adam Turner
a3139a5e2b
Reorganise badges
2022-06-02 23:26:01 +01:00
Adam Turner
ec8c2e3c3e
Reorganise links
2022-06-02 22:38:35 +01:00
Adam Turner
86a218ae8d
Add GitHub actions badge
2022-06-02 20:37:39 +01:00
Adam Turner
bd2957e304
Remove old badges
2022-06-02 20:37:22 +01:00
Thomas Nilsson
b32bd3ef5c
Remove leftover travis badge
2021-05-10 13:51:19 +02:00
Tetsuo Koyama
037b9e42fd
📛 CodeTriage
2020-07-12 05:39:08 +09:00
Stephen Finucane
d3021f644f
docs: Add contributing document
...
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:08:34 +01:00
Tetsuo Koyama
10fea0b664
📝 License badge
2019-12-06 13:18:40 +09:00
Jakub Wilk
5eabbae264
README: remove stray "__"
...
Fixes:
README.rst:: (ERROR/3) Anonymous hyperlink mismatch: 10 references but 11 targets.
2019-11-20 11:49:49 +01:00
Takeshi KOMIYA
7faeb793e2
Close #6658 : Add CODE_OF_CONDUCT ( #6661 )
...
* Close #6658 : Add CODE_OF_CONDUCT
* #6658 refine CoC
* Base on Django CoC: https://www.djangoproject.com/conduct/
* Simplify: we are a smaller project and can be more concise
* Add to ToC
* Link from README
* Link from index page
2019-10-06 16:41:37 +02:00
Jon Dufresne
9fb75a9af8
Correct capitalization of PyPI
...
As spelled on https://pypi.org/ .
2018-09-16 13:41:09 -07:00
mondeja
722a59d459
Specify version in README.rst readthedocs shield
...
Readthedocs status is shown as `docs unknown` before this change because any version is specified on image url.
2018-05-01 15:52:58 +02:00
Jon Dufresne
365c93f227
Update all pypi.python.org URLs to pypi.org
...
For details on the new PyPI, see the blog post:
https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-18 19:51:48 -07:00
Ray Bell
24468eddbe
Update README.rst with get in touch section
2018-02-20 15:59:14 -05:00
Thijs Triemstra
6ee4a6bc14
fix broken links on pypi page
2018-02-12 22:57:05 +01:00
Stephen Finucane
a3f9935d95
travis: Enable codecov coverage
...
This necessitates adding some basic coverage-py configuration [1] and
making sure the pytest-cov plugin uses said configuration [2]. Badges
are included.
Note that we do not run the 'coverage' tox target, which is reserved for
users.
[1] https://github.com/codecov/example-python
[2] https://bitbucket.org/ned/coveragepy/issues/512/
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-24 21:24:41 +00:00
Takeshi KOMIYA
b103b3c24a
doc: Use anonymous link target for README
2017-12-20 01:28:07 +09:00
Stephen Finucane
ac9ae4d54b
README: Fix typo
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 393f59d
("Improve README")
2017-12-19 16:02:05 +00:00
Stephen Finucane
a6f0ba0fc9
README: Cleanup badges
...
Add AppVeyor badge and include 'alt' attributes for the others.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:05:44 +00:00
Stephen Finucane
393f59da00
Improve README
...
We're going to be adding additional badges to this but, before we do
that, we should improve the README and remove a lot of the duplication
that has built up here.
The 'long_description' from 'setup.py' is moved into the README as there
is serious value in displaying this on GitHub, as much as there is value
in including the badges and other content from README.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-19 15:00:06 +00:00
Sanjeev Gupta
49a805cdaa
Update HTTP url to HTTPS
...
Also, avoid a redirect, by specifying target URL.
2017-05-30 00:38:13 +08:00
shimizukawa
3a4175c1cc
move badge to top. and add another badge.
2016-12-18 00:22:05 +09:00
shimizukawa
3efd2df99b
Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst.
2016-12-18 00:10:40 +09:00
Takeshi KOMIYA
780bf43cee
Add GPG key of shimizukawa
2016-12-14 00:55:31 +09:00
Takeshi KOMIYA
d57b395502
Add a release signature to README (ref: #2612 )
2016-07-02 16:37:00 +09:00
shimizukawa
ea25342acc
Support PEP-440 version spec for developers.
2015-03-14 16:46:24 +09:00
Georg Brandl
b45fec3813
add hint for test suite to readme
2015-03-06 07:51:32 +01:00
Ionel Cristian Mărieș
5d64cc0cc5
Correct few "typos".
2015-01-04 00:16:39 +02:00
Georg Brandl
30a2e5ba66
more bitbucket->github
2015-01-02 14:07:15 +01:00
Georg Brandl
3025368be8
Merge branch 'stable'
2015-01-02 13:54:28 +01:00
Georg Brandl
5f3d18dac2
readme: update drone->travis
2015-01-02 13:54:04 +01:00
Georg Brandl
97d2edf380
Very short introduction in README
2014-09-20 21:09:33 +02:00
Georg Brandl
561181be7a
show drone.io status on README
2014-09-20 21:06:44 +02:00
Takayuki Shimizukawa
463a039957
less markup for README.rst, less emoticon for official.
2014-08-31 00:38:11 +09:00
Takayuki Shimizukawa
0cfb00db79
Add documentation to make contribution easier.
2014-08-31 00:02:01 +09:00
Georg Brandl
4763419db1
Update Sphinx URL to new sphinx-doc.org domain.
2012-11-04 11:28:12 +01:00
Charles McLaughlin
30b392d865
edited and renamed the README so it's rendered properly on Bitbucket
2012-03-07 14:05:47 -08:00