sbot/README.md
mix irving 5fcc49c2e4 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
2015-09-15 15:17:30 +02:00

58 lines
1.2 KiB
Markdown

# Patchwork
**Patchwork is in active development. <a href="http://ssbc.github.io/">Sign up for our mailing list</a>, and we'll notify you when it's ready to use.**
Patchwork is a peer-to-peer network for sharing social feeds and open-source software. It gives you freedom to meet and collaborate online without surrendering ownership of your data.
Patchwork isn't a website: it runs on your computer and syncs over the Internet or WiFi. User-tracking and advertisements are actively prevented, and user applications are fully supported.
<a href="http://ssbc.github.io/">Learn more</a>
## 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
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