📝 add README

mzp · Oct 11, 2015 · 9671c44 · 9671c44
1 parent 382c630
commit 9671c44
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015 mzp.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,48 @@
+# LoveLiver
+
+![live photo demo](https://raw.githubusercontent.com/mzp/LoveLiver/master/demo.gif)
+
+LoveLiver is a CLI tool to create Apple's Live Photos from JPEG and MOV.
+
+## Requirements
+
+ * MacOS X 10.11 (El Capitan)
+ * Photos.app
+
+## Install
+
+ 1. Go to the releases page, find the version you want.
+ 2. Download the file. 
+ 3. Put the binary to somewhere you want (e.g. `/usr/local/bin`).
+ 4. Make sure it has execution bits turned on by `chmod a+x LoveLiver`.
+
+## Usage
+
+### Create Live Photos
+
+```
+$ ./LoveLiver --operation=livephoto --jpeg sample/original/IMG.JPG --mov sample/original/IMG.MOV --output sample/livephoto
+finish writing.
+```
+
+and drop & drag `sample/livephoto` directory to `Photos.app`.
+
+### Show metadata of JPEG
+
+```
+$ ./LoveLiver --operation=jpeg --jpeg sample/livephoto/IMG.JPG
+asset identifier: CDDD4450-642F-442B-8371-B46BC4229XXY
+```
+
+### Show metadata of QuickTime MOV
+
+```
+$ ./LoveLiver --operation=mov --mov sample/livephoto/IMG.MOV
+asset identifier: CDDD4450-642F-442B-8371-B46BC4229XXY
+still image time: 0
+```
+
+## Acknowledge
+
+ * [CommandLine](https://github.com/jatoben/CommandLine) is Copyright (c) 2014 Ben Gollmer and is licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+ * [Tda-style Hatsune Miku](https://bowlroll.net/file/4576) is created by tda.