sbot/README.md

79 lines
1.8 KiB
Markdown
Raw Normal View History

2015-08-02 03:57:06 +11:00
# Patchwork
2015-06-25 04:24:53 +11:00
2015-10-10 07:55:26 +11:00
[Build Here](http://vmpg.tetaneutral.net:8000/builds/)
52ceea61a562cc451a699cca0900476ff9ebe0a1 patchwork-linux.tgz
d4c1bd09f87323021949566d5225272323c785ae patchwork-mac.tgz
b6d85618c84675701478fca32bcb6b6c27273d65 patchwork-win.zip
2015-08-02 03:57:06 +11:00
2015-09-30 03:05:01 +11:00
Patchwork is a decentralized sharing app.
It was built for friends of the SSB project, to test basic functions.
We use it as a test-bed for features, and for our own daily messaging.
2015-08-02 03:57:06 +11:00
2015-09-30 03:05:01 +11:00
Because SSB is a research project, **you'll need to contact an SSB team member (in #scuttlebutt on Freenode) to get onto the network!**
That's our informal barrier to entry right now, since we're not prepared for lots of users yet.
2015-08-02 03:57:06 +11:00
2015-09-28 01:51:21 +11:00
[![Hermies the Hermit Crab](https://avatars2.githubusercontent.com/u/10190339?v=3&s=200)](https://github.com/ssbc/scuttlebot)
2015-09-26 07:53:22 +11:00
2015-09-30 03:05:01 +11:00
Patchwork embeds [Scuttlebot](https://github.com/ssbc/scuttlebot), so if you're running Patchwork, you don't need to run another scuttlebot server.
2015-08-02 03:57:06 +11:00
## Running Patchwork
2015-09-26 07:53:22 +11:00
Current install steps are:
```
2015-09-26 07:53:22 +11:00
# ubuntu
apt-get install automake libtool
# osx
brew install automake libtool
```
2015-09-26 07:53:22 +11:00
Also, you'll need to use iojs@2.
The easiest way to get this is [nvm](https://github.com/creationix/nvm).
```
nvm install iojs-v2.5.0
```
2015-09-26 07:53:22 +11:00
Then, install the software:
```
2015-09-26 07:53:22 +11:00
git clone https://github.com/ssbc/patchwork.git
cd patchwork
npm install
npm start
```
2015-09-26 07:53:22 +11:00
And then join a pub server.
2015-09-17 23:39:05 +11:00
## 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
```
2015-06-25 04:24:53 +11:00
```
npm install -d
npm run build
npm run pack
```
---
2015-06-25 04:24:53 +11:00
Relevant docs:
- https://github.com/maxogden/electron-packager
- https://github.com/loopline-systems/electron-builder
- https://github.com/atom/electron/tree/master/docs