Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite readme and index #6205

Merged
merged 4 commits into from
Jan 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 22 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,51 +1,45 @@
pip
===

The `PyPA recommended`_ tool for installing Python packages.
pip - The Python Package Installer
==================================

.. image:: https://img.shields.io/pypi/v/pip.svg
:target: https://pypi.org/project/pip/

.. image:: https://img.shields.io/travis/pypa/pip/master.svg?label=travis-ci
:target: https://travis-ci.org/pypa/pip

.. image:: https://img.shields.io/appveyor/ci/pypa/pip.svg?label=appveyor-ci
:target: https://ci.appveyor.com/project/pypa/pip/history

.. image:: https://readthedocs.org/projects/pip/badge/?version=latest
:target: https://pip.pypa.io/en/latest

.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/Linux?branchName=master&label=Windows
:target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=6
pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.

.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/macOS?branchName=master&label=macOS
:target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=7

.. image:: https://dev.azure.com/pypa/pip/_apis/build/status/Linux?branchName=master&label=Linux
:target: https://dev.azure.com/pypa/pip/_build/latest?definitionId=4
Please take a look at our documentation for how to install and use pip:

* `Installation`_
* `Documentation`_
* `Changelog`_
* `GitHub Page`_
* `Issue Tracking`_
* `Usage`_
* `Release notes`_

If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms:

* `Issue tracking`_
* `User mailing list`_
pradyunsg marked this conversation as resolved.
Show resolved Hide resolved
* `Dev mailing list`_
* `User IRC`_

If you want to get involved head over to GitHub to get the source code and feel free to jump on the developer mailing lists and chat rooms:

* `GitHub page`_
* `Dev mailing list`_
* `Dev IRC`_

Code of Conduct
---------------

Everyone interacting in the pip project's codebases, issue trackers, chat
rooms and mailing lists is expected to follow the `PyPA Code of Conduct`_.
rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.

.. _PyPA recommended: https://packaging.python.org/en/latest/current/
.. _package installer: https://packaging.python.org/en/latest/current/
.. _Python Package Index: https://pypi.org
.. _Installation: https://pip.pypa.io/en/stable/installing.html
.. _Documentation: https://pip.pypa.io/en/stable/
.. _Changelog: https://pip.pypa.io/en/stable/news.html
.. _GitHub Page: https:/pypa/pip
.. _Issue Tracking: https:/pypa/pip/issues
.. _Usage: https://pip.pypa.io/en/stable/
.. _Release notes: https://pip.pypa.io/en/stable/news.html
.. _GitHub page: https:/pypa/pip
.. _Issue tracking: https:/pypa/pip/issues
.. _User mailing list: https://groups.google.com/forum/#!forum/python-virtualenv
.. _Dev mailing list: https://groups.google.com/forum/#!forum/pypa-dev
.. _User IRC: https://webchat.freenode.net/?channels=%23pypa
Expand Down
45 changes: 35 additions & 10 deletions docs/html/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
pip
===
pip - The Python Package Installer
==================================

`User list <https://groups.google.com/forum/#!forum/python-virtualenv>`_ |
`Dev list <https://groups.google.com/forum/#!forum/pypa-dev>`_ |
`GitHub <https:/pypa/pip>`_ |
`PyPI <https://pypi.org/project/pip/>`_ |
User IRC: #pypa |
Dev IRC: #pypa-dev
pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.

The `PyPA recommended <https://packaging.python.org/en/latest/current/>`_ tool
for installing Python packages.
Please take a look at our documentation for how to install and use pip:

.. toctree::
:maxdepth: 1
Expand All @@ -20,3 +14,34 @@ for installing Python packages.
reference/index
development/index
news

If you find bugs, need help, or want to talk to the developers please use our mailing lists or chat rooms:

* `Issue tracking`_
* `User mailing list`_
* `User IRC`_

If you want to get involved head over to GitHub to get the source code and feel free to jump on the developer mailing lists and chat rooms:

* `GitHub page`_
* `Dev mailing list`_
* `Dev IRC`_

Code of Conduct
---------------

Everyone interacting in the pip project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.

.. _package installer: https://packaging.python.org/en/latest/current/
.. _Python Package Index: https://pypi.org
.. _Installation: https://pip.pypa.io/en/stable/installing.html
.. _Documentation: https://pip.pypa.io/en/stable/
.. _Changelog: https://pip.pypa.io/en/stable/news.html
.. _GitHub page: https:/pypa/pip
.. _Issue tracking: https:/pypa/pip/issues
.. _User mailing list: https://groups.google.com/forum/#!forum/python-virtualenv
.. _Dev mailing list: https://groups.google.com/forum/#!forum/pypa-dev
.. _User IRC: https://webchat.freenode.net/?channels=%23pypa
.. _Dev IRC: https://webchat.freenode.net/?channels=%23pypa-dev
.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
1 change: 1 addition & 0 deletions news/5815.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Re-write README and documentation index