From 7a12dbb5cacc71d1dd2d74d8cce8eb50ce2db121 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Tue, 10 Sep 2019 08:51:00 +0530 Subject: [PATCH] Doc: Write pipefile description (#3937) Doc: Write pipefile description --- docs/basics.rst | 6 ++++++ news/3913.doc.rst | 1 + 2 files changed, 7 insertions(+) create mode 100644 news/3913.doc.rst diff --git a/docs/basics.rst b/docs/basics.rst index 677a4716..9593d0c0 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -10,6 +10,12 @@ This document covers some of Pipenv's more basic features. ☤ Example Pipfile & Pipfile.lock -------------------------------- +Pipfiles contain information for the dependencies of the project, and supercede +the requirements.txt present in Python projects. You should add Pipfile in the +Git repository letting users who clone the repository the only thing required would be +installing Pipenv in the machine and type ``pipenv install``. Pipenv is a reference +implementation for using Pipfile. + .. _example_files: Here is a simple example of a ``Pipfile`` and the resulting ``Pipfile.lock``. diff --git a/news/3913.doc.rst b/news/3913.doc.rst new file mode 100644 index 00000000..54fbbfe8 --- /dev/null +++ b/news/3913.doc.rst @@ -0,0 +1 @@ +Documental description of how Pipfile works and association with Pipenv.