Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mathieudutour/git-sketch-plugin

:gem::octocat: A Git client generating pretty diffs built right into Sketch.
https://github.com/mathieudutour/git-sketch-plugin

git sketch sketch-plugin

Last synced: 27 days ago
JSON representation

:gem::octocat: A Git client generating pretty diffs built right into Sketch.

Awesome Lists containing this project

README

        

## This plugin was a first attempt to bring version control and collaboration to designers. Since then, Sketch evolved a lot and my new project takes advantages of them to unlock _true_ version control. Check it out: [http://kactus.io](http://kactus.io)

---

# git-sketch-plugin

[![GitHub release](https://img.shields.io/github/release/mathieudutour/git-sketch-plugin.svg?maxAge=2592000)](https://github.com/mathieudutour/git-sketch-plugin/releases)
[![GitHub release](https://img.shields.io/badge/Works%20with-Sketch%20Runner-blue.svg?colorB=308ADF)](http://bit.ly/SketchRunnerWebsite)

A Git client built right into [Sketch](http://www.bohemiancoding.com/sketch). Generate [pretty diffs](https://github.com/mathieudutour/git-sketch-plugin/pull/1/files) so that everybody knows what are the changes!

From ...
![Ugly](example/ScreenShotBad.png)

... To
![Pretty](example/ScreenShotNice.png)

![screen cast](example/ScreenCast.gif)

## Requirements

- [Sketch](http://sketchapp.com/) >= 3.4 (**not** with the sandboxed version ie from the App Store).
- [Git](https://git-scm.com/) (coming with OS X so you shouldn't have to do anything)
- [Xcode Command Line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/)

## Installation

### From a release (simplest)

- [Download](https://github.com/mathieudutour/git-sketch-plugin/releases/latest) the latest release of the plugin
- Un-zip
- Double-click on Git.sketchplugin

### From the sources

- Clone the repo
- Install the dependencies (`npm install`)
- Build (`npm run build`)
- Double-click on Git.sketchplugin

## Documentation

For a Getting started guide, FAQ, etc. check out our [docs](https://github.com/mathieudutour/git-sketch-plugin/tree/master/docs)!

## Want to contribute?

Anyone can help make this project better - check out our [Contributing guide](/.github/CONTRIBUTING.md)!