Skip to content

Commit

Permalink
Update README to use build script
Browse files Browse the repository at this point in the history
  • Loading branch information
AvaLovelace1 committed Jan 10, 2024
1 parent 483005e commit fa74572
Showing 1 changed file with 9 additions and 48 deletions.
57 changes: 9 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SpeedSketch: Timed Drawing App

**[Download (Mac)](https://github.com/AvaLovelace1/speed-sketch/releases/latest)**
**[Download (Mac + Windows)](https://github.com/AvaLovelace1/speed-sketch/releases/latest)**

**SpeedSketch** is a free app that allows you to create timed drawing sessions using photo references on your own
computer—perfect for gesture studies, figure drawing practice, and the like.
Expand All @@ -15,67 +15,28 @@ random order, each for a specified amount of time.

## Installation

### Pre-built binaries (Mac)
### Pre-built binaries: Mac (Apple Silicon) + Windows

You can find pre-built Mac applications (Intel and Apple Silicon)
You can find pre-built Mac (Apple Silicon) and Windows applications
**[here](https://github.com/AvaLovelace1/speed-sketch/releases/latest)**.

### Building from source (Mac + Windows)

#### Prerequisites
### Building from source: Mac (Apple Silicon) + Mac (Universal) + Windows)

To build from source, you must have [Python](https://www.python.org/downloads/) installed.

#### Instructions for Mac (bash/zsh)

First clone this repository:

```bash
git clone https://github.com/AvaLovelace1/speed-sketch.git
cd speed-sketch
```

Then, create the Python virtual environment:

```bash
python3 -m venv .venv # Initialize python virtualenv
source .venv/bin/activate # Activate virtualenv
pip install -r requirements.txt # Install required packages
```

To build the application, we use [py2app](https://py2app.readthedocs.io/en/latest/).
The app will be saved to the folder `dist`.

```bash
pip install py2app
python setup.py py2app
```

> [!NOTE]
> Issues may arise if [PyInstaller](http://www.pyinstaller.org) is installed at the same time as py2app.
> If this is the case, try uninstalling PyInstaller.
#### Instructions for Windows (cmd.exe)

First clone this repository:

```bash
git clone https://github.com/AvaLovelace1/speed-sketch.git
cd speed-sketch
```

Then, create the Python virtual environment:
Then, run the provided build script:

```bash
python3 -m venv .venv # Initialize python virtualenv
.venv\Scripts\activate.bat # Activate virtualenv
pip install -r requirements.txt # Install required packages
./build_mac.zsh # On Mac
# OR
build_windows.cmd # On Windows
```

To build the application, we use [py2exe](http://www.py2exe.org).
The app will be saved to the folder `dist`.

```bash
pip install py2exe
python setup.py py2exe
```
The app will be saved to the folder `bin`.

0 comments on commit fa74572

Please sign in to comment.