Skip to content

Commit c813473

Browse files
committed
README updates.
1 parent 67df617 commit c813473

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@
1212

1313
Structure your Flask apps in a scalable and intelligent way using Blueprints.
1414

15-
This repository contains source code for the accompanying tutorial on Hackers and Slackers: https://hackersandslackers.com/flask-blueprints/
16-
A live demo of this repository can be found here: https://flaskblueprints.hackersandslackers.app/
15+
**Tutorial**: https://hackersandslackers.com/flask-blueprints/
16+
**Demo**: https://flaskblueprints.hackersandslackers.app/
1717

1818

19-
# Installation
19+
# Getting Started
2020

21-
Get running locally in two steps:
21+
Get set up locally in two steps:
2222

23-
## Environment Variables
23+
### Environment Variables
2424

2525
Replace the values in **.env.example** with your values and rename this file to **.env**:
2626

27-
* `FLASK_APP`: Entry point of your application (should be `wsgi.py`).
28-
* `FLASK_ENV`: The environment to run your app in (either `development` or `production`).
27+
* `FLASK_APP`: Entry point of your application; should be `wsgi.py`.
28+
* `FLASK_ENV`: The environment in which to run your application; either `development` or `production`.
2929
* `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
30-
* `LESS_BIN`: Path to your local LESS installation via `which lessc` (optional for static assets).
31-
* `ASSETS_DEBUG`: Debug asset creation and bundling in `development` (optional).
32-
* `LESS_RUN_IN_DEBUG`: Debug LESS while in `development` (optional).
33-
* `COMPRESSOR_DEBUG`: Debug asset compression while in `development` (optional).
30+
* `LESS_BIN` *(optional for static assets)*: Path to your local LESS installation via `which lessc`.
31+
* `ASSETS_DEBUG` *(optional)*: Debug asset creation and bundling in `development`.
32+
* `LESS_RUN_IN_DEBUG` *(optional)*: Debug LESS while in `development`.
33+
* `COMPRESSOR_DEBUG` *(optional)*: Debug asset compression while in `development`.
3434

3535

3636
*Remember never to commit secrets saved in .env files to Github.*
3737

38-
## Installation
38+
### Installation
3939

4040
Get up and running with `make deploy`:
4141

0 commit comments

Comments
 (0)