From 5fcc49c2e4a404d232f1d26fd187fde5ee38b200 Mon Sep 17 00:00:00 2001 From: mix irving Date: Tue, 15 Sep 2015 15:17:30 +0200 Subject: [PATCH] add dependencies details I see @dominictarr has an open PullRequest which links out to details. I found it a little inconvenient and missed things first time (I still may be missing things because npm pack isn't working for me yet) I also wonder if a recommended version of Node / IOJS would be nice here ... I saw references to a range of versions like `> Nodev0.12`, and `= IOv2.5.0` . Would be good to know if there is anything tricky that needs to be known there --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b275fe3..02d4ea9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,39 @@ Patchwork isn't a website: it runs on your computer and syncs over the Internet Learn more -## Some development notes: + +## Running Patchwork + +**Dependencies:** + +``` +# Linux dependencies +apt-get install automake + +# OSX dependencies +brew install automake +``` + +``` +npm install +npm start +``` + + +## Development & App-building : + + +**Dependencies** + +``` +# Linux dependencies +add-apt-repository ppa:ubuntu-wine/ppa -y +apt-get update +apt-get install nsis wine + +# OSX dependencies +brew install makensis wine +``` ``` npm install -d @@ -16,8 +48,10 @@ npm run build npm run pack ``` +--- + Relevant docs: - https://github.com/maxogden/electron-packager - https://github.com/loopline-systems/electron-builder - - https://github.com/atom/electron/tree/master/docs \ No newline at end of file + - https://github.com/atom/electron/tree/master/docs