🎉 the beginning

noelyahan · Sep 24, 2018 · 125299f · 125299f
commit 125299f
Show file tree

Hide file tree

Showing 106 changed files with 3,060 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+.idea/
+dist
+*.gif
+*.jpg
+*.jpeg
+*.png
+!examples/**/*.jpg
+!examples/**/*.png
+!examples/**/*.jpeg
+!examples/**/*.gif
+!testdata/**/*.jpg
+!testdata/**/*.gif
+!testdata/**/*.png
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -0,0 +1,57 @@
+project_name: mergi
+builds:
+- env:
+    - CGO_ENABLED=0
+  binary: mergi
+  main: cmd/mergi/main.go
+  goos:
+    - windows
+    - darwin
+    - linux
+    - freebsd
+    - openbsd
+    - netbsd
+  goarch:
+    - 386
+    - amd64
+    - arm
+    - arm64
+  ignore:
+    - goos: freebsd
+      goarch: arm
+      goarm: 6
+    - goos: openbsd
+      goarch: arm
+      goarm: 6
+env_files:
+  github_token: ./github_token
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs'
+      - '^tests'
+      - Merge pull request
+      - Merge branch
+archive:
+  name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}_v{{ .Arm }}{{ end }}'
+  format: tar.gz
+  format_overrides:
+    - goos: windows
+      format: zip
+  files:
+    - none*
+  wrap_in_directory: false
+  replacements:
+    amd64: 64-bit
+    386: 32-bit
+    arm: ARM
+    arm64: ARM64
+    darwin: macOS
+    linux: Linux
+    windows: Windows
+    openbsd: OpenBSD
+    netbsd: NetBSD
+    freebsd: FreeBSD
+release:
+  draft: true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# Contributing Guide
+
+* [Style Guide](#style-guide)
+* [Build](#build)
+* [Features Requested](#features-requested)
+
+
+## Style Guide
+### Code format
+Mergi uses [gofmt](https://golang.org/cmd/gofmt) to format the code, you must use [gofmt](https://golang.org/cmd/gofmt) to format your code before submitting.
+
+### linter
+Mergi recommend using [golint](https://github.com/golang/lint) or [gometalinter](https://github.com/alecthomas/gometalinter) to check your code format.
+
+
+## Build
+
+Make sure that this folder is in `GOPATH`, then:
+
+```bash
+$ go build ./cmd/mergi
+```
+
+### Mergi needs you ! :)
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Noel Yahan
+
+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,226 @@
+![Mergi Logo](./logo/logo.png)
+
+## :tada: Basic Overview
+
+Image manupulation [<b>go library</b>](http://godoc.org/github.com/noelyahan/mergi) plus [<b>cross platform CLI tool</b>](https://github.com/noelyahan/mergi/tree/master/cmd/mergi).
+
+## ⚡ Features
+
+- 🛠 Merge
+- ✂️ Crop
+- 💣 Resize
+- 🖃 Watermark
+- 💖 Animate
+
+<br />
+
+## 🚀 Getting started
+
+### Install via `go get`
+
+To install Mergi, use `go get`, or download the binary file from [Releases](https://github.com/noelyahan/mergi/releases) page.
+
+```bash
+$ go get github.com/noelyahan/mergi
+```
+
+Usage:
+
+```
+ ╔╦╗╔═╗╦═╗╔═╗╦
+ ║║║║╣ ╠╦╝║ ╦║
+ ╩ ╩╚═╝╩╚═╚═╝╩
+ let's go & makes imagine fun
+ http://mergi.io
+ version 1.0.0
+
+  -a string
+    	Enter animation type=[sprite, slide] and the delay to get mergi gif animation ex: smooth 10
+  -c value
+    	Enter crop points and height and width ex: x y w h
+  -f string
+    	Enter true if you want to process the final output
+  -i value
+    	Enter images that want to merge ex: /path/img1 or url
+  -o string
+    	Enter image outputs file ex: out.png or out.jpg (default "out.png")
+  -r value
+    	Enter resize width and height of the output ex: 100 200
+  -t string
+    	Enter a merge template string ex: TBTBTB (default "T")
+  -w value
+    	Enter watermark image and points to place it, [-r w h] is optional  ex: /path/img -r w h x y
+
+```
+<br />
+
+#### 🛠 Merge
+
+Image 1                     | Image 2                               | Result Image
+-----------------------------------|-------------------------------------------|------------------------------------------
+![dstImage](testdata/glass-3306625_240_160.jpg)|![srcImage](testdata/glass-3306662_240_160.jpg)  | ![dstImage](testdata/doc/merge_tt.png)
+![dstImage](testdata/glass-3306625_240_160.jpg)|![srcImage](testdata/glass-3306662_240_160.jpg)  | ![dstImage](testdata/doc/merge_tb.png)
+
+##### `Mergi Tool`
+###### Horizontal 
+```bash
+mergi \
+-t TT \
+-i testdata/glass-3306625_240_160.jpg \
+-i testdata/glass-3306662_240_160.jpg
+```
+
+###### Vertical 
+```bash
+mergi \
+-t TB \
+-i testdata/glass-3306625_240_160.jpg \
+-i testdata/glass-3306662_240_160.jpg
+```
+##### `Mergi Library`
+```go
+image1, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306625_240_160.jpg"))
+image2, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306662_240_160.jpg"))
+
+horizontalImage, _ := mergi.Merge("TT", []image.Image{image1, image2})
+mergi.Export(loader.NewFileExporter(horizontalImage, "horizontal.png"))
+
+verticalImage, _ := mergi.Merge("TB", []image.Image{image1, image2})
+mergi.Export(loader.NewFileExporter(verticalImage, "vertical.png"))
+```
+
+
+<br />
+
+#### ✂️ Crop
+Image                    | Result Image
+-----------------------------------|------------------------------------------
+![srcImage](testdata/glass-3306662_240_160.jpg) | ![dstImage](testdata/doc/crop.png)
+
+##### `Mergi Tool`
+```bash
+mergi \
+-i testdata/glass-3306662_240_160.jpg \
+-c "0 0 120 160"
+```
+
+##### `Mergi Library`
+```go
+img, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306662_240_160.jpg"))
+res, _ := mergi.Crop(img, image.Pt(0, 0), image.Pt(120, 160))
+mergi.Export(loader.NewFileExporter(res, "crop.png"))
+```
+
+<br />
+
+#### 💣 Resize
+Image                    | Result Image
+-----------------------------------|-------------------------------------------
+![srcImage](testdata/glass-3306662_240_160.jpg) | ![dstImage](testdata/doc/resize.png)
+
+##### `Mergi Tool`
+```bash
+mergi \
+-i testdata/glass-3306662_240_160.jpg \
+-r "80 120"
+```
+
+##### `Mergi Library`
+```go
+img, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306662_240_160.jpg"))
+res, _ := mergi.Resize(img, uint(80), uint(120))
+mergi.Export(loader.NewFileExporter(res, "resize.png"))
+```
+
+<br />
+
+#### 🖃 Watermark
+Image                   | Watermark Image                             | Result Image
+-----------------------------------|-------------------------------------------|------------------------------------------
+![srcImage](testdata/glass-3306662_240_160.jpg) | ![dstImage](testdata/mergi_logo_watermark_90x40.png) | ![dstImage](testdata/doc/watermark.png)
+
+##### `Mergi Tool`
+```bash
+mergi \
+-i testdata/glass-3306662_240_160.jpg \
+-w "testdata/mergi_logo_watermark_90x40.png 20 60"
+```
+
+##### `Mergi Library`
+```go
+originalImage, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306662_240_160.jpg"))
+watermarkImage, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-mergi_logo_watermark_90x40.jpg"))
+
+res, _ := mergi.Watermark(watermarkImage, originalImage, image.Pt(20, 60))
+mergi.Export(loader.NewFileExporter(res, "watermark.png"))
+```
+
+<br />
+
+#### 💖 Animate
+Image 1                     | Image 2                               | Result Animation
+-----------------------------------|-------------------------------------------|------------------------------------------
+![srcImage](testdata/glass-3306662_240_160.jpg) | ![dstImage](testdata/glass-3306625_240_160.jpg) | ![dstImage](testdata/doc/sprite.gif)
+![srcImage](testdata/glass-3306662_240_160.jpg) | ![dstImage](testdata/glass-3306625_240_160.jpg) | ![dstImage](testdata/doc/smooth.gif)
+
+##### `Mergi Tool`
+###### Sprite Animation 
+```bash
+mergi \
+-t "TT" \
+-i testdata/glass-3306625_240_160.jpg \
+-i testdata/glass-3306662_240_160.jpg \
+-a "sprite 50"
+```
+###### Smooth Animation
+```bash
+mergi \
+-t "TT" \
+-i testdata/glass-3306625_240_160.jpg \
+-i testdata/glass-3306662_240_160.jpg \
+-a "smooth 5"
+```
+
+##### `Mergi Library`
+```go
+image1, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306625_240_160.jpg"))
+image2, _ := mergi.Import(loader.NewFileImporter("./testdata/glass-3306662_240_160.jpg"))
+
+gif, _ := mergi.Animate([]image.Image{image1, image2}, 50)
+mergi.Export(loader.NewAnimationExporter(gif, "out.gif"))
+```
+
+<br />
+
+Learn more [examples](examples)
+
+## 💻 Contribute
+
+- Clone the repository
+```bash
+$ go get github.com/noelyahan/mergi
+```
+- Run unit tests
+- Fix bug
+- Add new feature
+- Push
+
+<br />
+
+### 🌠 Contributors
+
+  <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+| [<img src="https://avatars1.githubusercontent.com/u/6106461?s=460&v=4" width="100px;"/><br /><sub>Noel</sub>](https://twitter.com/noelyahan)<br />💻 📖 💬 👀 🤔 🎨 |
+| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | 
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<br/>
+This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
+Contributions of any kind are welcome!
+
+<br />
+
+### 🔵 License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details