Skip to content

Commit 235133b

Browse files
committed
updated README
1 parent 7205d2d commit 235133b

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

README.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,26 @@
11
# Flask Skeleton
22

3-
Flask starter project...
3+
Flask starter project for [Cookiecutter](https://github.com/audreyr/cookiecutter).
44

55
[![Build Status](https://travis-ci.org/realpython/flask-skeleton.svg?branch=master)](https://travis-ci.org/realpython/flask-skeleton)
66

77
## Quick Start
88

99
### Basics
1010

11-
1. cd into the `{{cookiecutter.app_slug}}` directory.
12-
1. Create and activate a virtualenv
13-
1. Install the requirements
11+
Install Cookiecutter globally:
1412

13+
```sh
14+
$ pip install cookiecutter
15+
```
16+
17+
Generate the boilerplate:
18+
19+
```sh
20+
$ cookiecutter https://github.com/realpython/flask-skeleton.git
21+
```
22+
23+
Create and activate a virtual environment, and then install the requirements.
1524

1625
### Set Environment Variables
1726

@@ -63,19 +72,3 @@ With coverage:
6372
```sh
6473
$ python manage.py cov
6574
```
66-
67-
### Cookiecutter Template
68-
69-
Alternatively you can use the cookiecutter template.
70-
71-
First, get Cookiecutter:
72-
73-
```sh
74-
$ pip install cookiecutter
75-
```
76-
77-
Now run it against this repo:
78-
79-
```sh
80-
$ cookiecutter https://github.com/realpython/flask-skeleton.git
81-
```

0 commit comments

Comments
 (0)