Skip to content

Commit

Permalink
Update README for clarity.
Browse files Browse the repository at this point in the history
  • Loading branch information
James Vorderbruggen authored Aug 27, 2019
1 parent 4da377b commit 9198323
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 9198323

Please sign in to comment.