From 7f3f1fb52bef6c1076fbb48c899d691b69f6885d Mon Sep 17 00:00:00 2001 From: sanjaytaylor2012 <66386109+sanjaytaylor2012@users.noreply.github.com> Date: Sun, 22 Sep 2024 09:30:33 -0400 Subject: [PATCH] adding documentation --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index df4d41cb..515ad7f4 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,40 @@ $ flask run * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) ``` +## Installation Instructions +To install Flask, pip, the package manager included with Python, is used. +It is considered best practice to start a Flask project within a virtual +environment. This practice ensures that any packages installed are confined +to the virtual environment, keeping them separate from the global environment +of the system. By doing so, it prevents potential conflicts between package +versions, maintaining compatibility and stability across different projects. + + + +To create a virtual environment run the command: +``` +python -m venv venv +``` + +To activate a virtual environment on Windows: +``` +.\venv\Scripts\activate +``` + +To activate a virtual environment on macOS and Linux: +``` +source venv/bin/activate +``` + +To install the flask python package run the command: +``` +pip install flask +``` + +To deactivate the virtual environment run the command: +``` +deactivate +``` ## Donate