gh-63 Add instructions to the Readme for building the GUI app

This commit is contained in:
Jaisen Mathai 2016-01-04 23:49:36 -08:00
parent 4b90d322d9
commit 5d4919ba1a
4 changed files with 70 additions and 8 deletions

View File

@ -1,9 +1,11 @@
# Hello, I'm Elodie
~~ *Your Personal EXIF-based Photo Assistant* ~~
~~ *Your Personal EXIF-based Photo, Video and Audio Assistant* ~~
[![Build Status](https://travis-ci.org/jmathai/elodie.svg?branch=master)](https://travis-ci.org/jmathai/elodie) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jmathai/elodie/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jmathai/elodie/?branch=master)
I work tirelessly to make sure your photos are always sorted and organized so you can focus on more important things. By photos I mean JPEG, DNG, NEF and common video files.
<p align="center"><img src ="creative/logo@300x.png" /></p>
I work tirelessly to make sure your photos are always sorted and organized so you can focus on more important things. By photos I mean JPEG, DNG, NEF and common video and audio files.
You don't love me yet but you will.
@ -14,15 +16,25 @@ I only do 3 things.
*NOTE: make sure you've installed everything I need before running the commands below. [Instructions](#install-everything-you-need) at the bottom of this page.*
## Two interfaces, same result
I can be used as a GUI taskbar app or through the command line. My GUI app is great for updating EXIF on existing photos while my command line tools are great for setting up automated jobs.
Read the [instructions on building the GUI taskbar app](tree/master/app) for more information.
## See me in action
Watch me importing photos and organizing them.
Updating EXIF of photos using the GUI taskbar app.
[![IMAGE ALT TEXT](http://img.youtube.com/vi/oOvKpUO3LLs/0.jpg)](http://www.youtube.com/watch?v=oOvKpUO3LLs "Import Photos")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/fF_jGCaMog0/0.jpg)](http://www.youtube.com/watch?v=fF_jGCaMog0 "Updating Photos Using GUI Taskbar App")
Sometimes photos don't have much information for me to organize them well. Here is how you can fix them up.
Importing and organizing photos from the command line.
[![IMAGE ALT TEXT](http://img.youtube.com/vi/7kqirQRQ--4/0.jpg)](http://www.youtube.com/watch?v=7kqirQRQ--4 "Updating Photos")
[![IMAGE ALT TEXT](http://img.youtube.com/vi/oOvKpUO3LLs/0.jpg)](http://www.youtube.com/watch?v=oOvKpUO3LLs "Import Photos Using the Command Line")
Updating EXIF of photos from the command line.
[![IMAGE ALT TEXT](http://img.youtube.com/vi/7kqirQRQ--4/0.jpg)](http://www.youtube.com/watch?v=7kqirQRQ--4 "Updating Photos Using the Command Line")
## The dream setup I am optimized for

View File

@ -1,2 +0,0 @@
Work in progress
----------------

52
app/Readme.md Normal file
View File

@ -0,0 +1,52 @@
# Hello, I'm Elodie's GUI
~~ *Your Personal EXIF-based Photo, Video and Audio Assistant* ~~
<p align="center"><img src ="../../../blob/master/creative/logo@300x.png" /></p>
My GUI taskbar app sits nestled away in your taskbar until you need me.
Let's say you took a few hundred photos in New York City. I'll have put the photos into a folder named *New York City*. You decide you'd rather organize those photos into a folder named *Summer in NYC*. What you'd do is select the photos using Finder and drag them onto my taskbar icon. I'll display a few options and one of them would be to *Create album*. Type in an album name and I'll add this to the EXIF of your photos and move them to a folder with the same name.
*NOTE: I've extensively used the GUI but it's a work in progress. Feedback is welcome. Due to [gh-44](https://github.com/jmathai/elodie/issues/44) we're unable to provide executables for download but you can build it yourself.*
## See me in action
Updating EXIF of photos using the GUI taskbar app.
[![IMAGE ALT TEXT](http://img.youtube.com/vi/fF_jGCaMog0/0.jpg)](http://www.youtube.com/watch?v=fF_jGCaMog0 "Updating Photos Using GUI Taskbar App")
## Building the app
You'll need to bundle up the python dependencies and create an electron app using Node.js.
### Bundling the python libraries
First you'll need to [install the python dependencies](../../../#install-everything-you-need).
Once you've done that you'll need to install `pyinstaller`.
```
pip install pyinstaller
```
Next you can `cd` to the root of the repository and run `pyinstaller`.
```
pyinstaller elodie.spec
```
This should create a `dist` folder that bundles all of the dependencies. Now you're ready to build the GUI app.
### Building the GUI app
The GUI app is written using [Node.js](https://github.com/nodejs) and [Electron](https://github.com/atom/electron) and you'll need [electron-packager](https://github.com/maxogden/electron-packager) to create an executable file for your operating system.
I'm going to assume you've got *Node.js* installed. I've successfully built the app using version `5.1.0` on OS X.
```
# use --platform=win32 for Windows or --platform=linux for linux
electron-packager . Elodie --platform=darwin --arch=x64 --version=0.34.2 --overwrite
```
This will create a folder named `Elodie-darwin-x64` which contains the executable. Running the executable should add my face to your taskbar which you can click on or drag photos over.

BIN
creative/logo@300x.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB