From 91983230956ee06f3ad6dda3fb6cfa4f6434aec5 Mon Sep 17 00:00:00 2001 From: James Vorderbruggen Date: Tue, 27 Aug 2019 11:17:11 -0400 Subject: [PATCH] Update README for clarity. --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 751d156..87ec149 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,25 @@ This application was developed in partnership with Mind The Gap, Boston, 501(c)3 ## Building The Application ## -This cross-platform app was generated by [Briefcase](https://github.com/pybee/briefcase) - part of [The BeeWare Project](https://pybee.org/.) - -First, download the source code and navigate to the project dir. - +### Download source code ### ``` git clone https://github.com/JamesVorder/email_nudges.git cd ./email_nudges ``` +### Set up a virtual environment ### -Then, you'll want to create a [virtual environment](https://docs.python.org/3/library/venv.html). - -`python3 -m venv ./.py3env` - -You can now activate the virtual environment. - -`. ./.py3env/bin/activate` +``` +python3 -m venv ./.py3env +. ./.py3env/bin/activate +``` -Finally, install all of the requirements into the virtual environment. +### Install dependencies ### `pip install -r requirements.txt` +### Build with Briefcase ### +This cross-platform app was generated by [Briefcase](https://github.com/pybee/briefcase) - part of [The BeeWare Project](https://pybee.org/.) + Depending on the desired *output*, run one of the following commands from your python3 virtual environment: - `python build.py linux -s` - `python build.py macos -s`