Skip to content

Commit

Permalink
minor edits and corrections to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bpops committed Jul 6, 2020
1 parent 8f68b8f commit 4ef5af7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ TimeSlide is just pretty packaging (or an attempt of it). The hard work is by th

## Setup for Development

In MacOS, install [homebrew](https://brew.sh). Then, use it to install Python 3.7 (*not* 3.8) with `brew install python3`. Ensure it is linked in your path (`brew link python3`). You can always double-check that this is the correct version: `python --version` should show 3.7. Next, run the bootstrap file which will clone deoldify, download the colorizing models, and install all python requirements in a virtual environment.
In MacOS, install [homebrew](https://brew.sh). Then, use it to install Python 3.7 (*not* 3.8) with `brew install python3`. Ensure it is linked in your path (`brew link python3`). You can always double-check that this is the correct version: `python --version` should show 3.7.

Next, run the bootstrap file which will clone deoldify, download the colorizing models, and install all python requirements in a virtual environment.
```
source bootstrap.sh
```
Expand All @@ -23,7 +24,7 @@ python timeslide.py

## Bundle for MacOS

Since the whole point of TimeSlide is ease of use, we require a solution for bundling the app that can be distributed to others. To do this, first open the file `timeslide.spec` and ensure that the path to your homebrew version (Cellar'ed) `libpng16.16.dylib` is correct (slight modifications may be necessary depending on version number.)
Since the whole point of TimeSlide is ease of use, we require a solution for bundling the app that can be distributed to others. To do this, first open the file `timeslide.spec` and ensure that the path to your homebrew (Cellar'ed) version of `libpng16.16.dylib` is correct (slight modifications may be necessary depending on version number.)

Next, in terminal, run:
```
Expand All @@ -32,14 +33,14 @@ source bundle.sh

With this, pyinstaller will bundle the app, including all necessary python modules and dynamic libraries. It will be bundled into a single `.app` bundle (as well as a binary executable) under the `dist` folder. Additionally, the bash script will copy over the icon files into the `.app` file.

Recommend you then comporess the `.app` file into a zip file before sharing via file-sharing services, e.g., iCloud or DropBox.
We recommend you then comporess the `.app` file into a zip file before sharing via file-sharing services, e.g., [iCloud](https://www.icloud.com) or [DropBox](https://www.dropbox.com).

## Running the Bundled MacOS App

Please note that distributing the application to others will require that they enable unidentified developer apps to run on any somewhat recent version of MacOS. This can be done by providing those users with the following instructions.

1. Press COMMAND + SPACEBAR.
2. Type `term`. When the Terminal.app shows, click it (or hit ENTER).
1. Press `` + `SPACEBAR`.
2. Type `term`. When the Terminal.app shows, click it (or hit `ENTER`).
3. In the window, type `sudo spctl --master-disable` (note double hyphens before `master`.)
4. Enter password as required.
5. Open System Preferences.
Expand Down

0 comments on commit 4ef5af7

Please sign in to comment.