From 7d8f4e5ac0243889c0f9b5fb81a098d472134352 Mon Sep 17 00:00:00 2001 From: Mike Nikles Date: Fri, 25 Jun 2021 20:11:45 -0400 Subject: [PATCH] Standardize the README content. --- README.rst | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 245b941..7875f10 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,19 @@ -Flaskr -====== +# A Python Flask template on Gitpod -The basic blog app built in the Flask `tutorial`_. +This is a [Python Flask](https://flask.palletsprojects.com/en/2.0.x) template configured for ephemeral development environments on [Gitpod](https://www.gitpod.io/). -.. _tutorial: https://flask.palletsprojects.com/tutorial/ +## Next Steps +Click the button below to start a new development environment: -Run -------- +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/gitpod-io/template-python-flask) -Open a workspace - https://gitpod.io/from-referrer/ +## Get Started With Your Own Project +### A new project -Test ----- +Click the above "Open in Gitpod" button to start a new workspace. Once you're ready to push your first code changes, Gitpod will guide you to fork this project so you own it. -:: +### An existing project - $ pip install '.[test]' - $ pytest - -Run with coverage report:: - - $ coverage run -m pytest - $ coverage report - $ coverage html # open htmlcov/index.html in a browser +To get started with Python Flask on Gitpod, add a [`.gitpod.yml`](./.gitpod.yml) file which contains the configuration to improve the developer experience on Gitpod. To learn more, please see the [Getting Started](https://www.gitpod.io/docs/getting-started) documentation.