commit bf0e73b8324cb3f9dc49d9a4a48f2b946187f1f1
parent b8ea9f21ea593f4db1ed67a645443e5a00841e16
Author: Jack Mordaunt <jackmordaunt@gmail.com>
Date: Sun, 2 May 2021 13:47:11 +0800
doc: update readme
Diffstat:
| M | readme.md | | | 85 | +++++++++---------------------------------------------------------------------- |
1 file changed, 9 insertions(+), 76 deletions(-)
diff --git a/readme.md b/readme.md
@@ -1,8 +1,8 @@
# Giffer
-> Create gifs from videos!
+> Create gifs from videos!
-## Take a look
+## Take a look
<img src="docs/usage.gif" alt="usage animation" width="100%">
@@ -12,81 +12,15 @@
-## Tech
+## Tech
-- Go
-- FFmepg
-- Vuejs
-- Native webview / Chrome / localhost
+- Go (gioui.org)
+- FFmepg
-## About
+## About
-This project is about learning to bring a project to a state "completion", instead of leaving it in the half broken pre-alpha state that many projects get lost in. As such the core business logic is purposely thin, allowing more space to focus on bringing it all together into a cohesive whole.
+Giffer provides a simple UI for converting slices of video to animated GIF images.
-The current build is an MVP; that is, it functionally performs it's core objective without regard to bells, whistles and refinements - which are planned.
+### Install
-## Structure
-
-### Core
-
-The root package contains the "core" domain logic. It is extremely thin by design, but not as cohesive or abstract as I'd like it to be. As the app develops, this is where the core abstractions will be.
-
-### Desktop
-
-As it stands the bulk of the code is in the `cmd/desktop` package, which is the entry point for the desktop application. This involves setting up the requisite http endpoints and starting the webview to render the UI.
-
-#### HTTP Interface
-
-HTTP is used to comminicate between the core logic and the user interface logic.
-
-The http endpoints include a static file server to serve the UI, endpoints to create and serve the gifs, and dynamic websocket enpoints to push notifications to the UI.
-
-#### User Interface
-
-The UI code lives inside `cmd/desktop/ui`. Since the UI is coupled to the desktop application, it made sense to place it in this sub directory. `yarn` is used to develop and compile the Vue based UI.
-
-### Building
-
-Package `cmd/build` is the build "script" designed to produce standalone artifacts, such as `Giffer.app` for Mac and `Giffer.exe` for Windows, ready for distribution.
-
-Building cross platform for desktop is a little bit more complex than a simple `go build -o Giffer`. Building involves the following core steps:
-
-- Compile Go files
-- Compile Vue files
-- Embed compiled Vue files in Go binary
-- Bundle a static build of FFmpeg
-- Bundle platform specific icon (`.icns` or `.ico`)
-
-## Features
-
-MVP
-- [x] Produce Gif image from URL
- - [x] Download video files from various common sites
- - [x] Convert video to Gif image
- - [x] Persist produced Gif images
- - [x] Save image to local disk (via drag)
-- Platform Bundles
- - [x] `.app` for MacOS
- - [ ] `.exe` for Windows
-
-Refinements
-- [ ] List and manipulate stored Gif images
- - [ ] Edit name and other metadata
- - [ ] Encode caption onto Gif
- - [ ] Download/Save button
- - [ ] Shareable links
- - [ ] Drag resize
- - [ ] Interactive clip selection
-- [ ] Support for local video files
-- [ ] Authentication (eg, OAuth)
-- [ ] Authorisation (eg, different user experience based on account attributes)
-- [ ] Compress and optimize gif images (imagemagick? pure Go?)
- - imagemagick is non-trivial to package and ditribute cross platform
-
-Infrastructure
-- [ ] Github releases
-- [ ] Hosted storage
-- [ ] Cloud hosted web ui
-- [ ] Continuous integration
-- [ ] Code signing
-- [ ] Landing page website
-\ No newline at end of file
+`go get github.com/jackmordaunt/giffer/cmd/gio`
