| README.mdView |
|---|
| 17 | 17 … | The easiest way to get started is using [patchwork](https://github.com/ssbc/patchwork), a classic social networking [application](./applications.md). |
| 18 | 18 … | |
| 19 | 19 … |  |
| 20 | 20 … | |
| 21 | | -## Install Patchwork |
| 21 … | +### Easy path |
| 22 | 22 … | |
| 23 | | -### Download Installers for Windows, macOS and Linux |
| 23 … | +1. [Download an Installer](https://github.com/ssbc/patchwork/releases) for Windows, macOS and Linux |
| 24 … | +2. Connect to the network |
| 25 … | + - get a [pub invite code](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers) |
| 26 … | + - in `patchwork`: click "+ Join Pub" and paste the invite code |
| 24 | 27 … | |
| 25 | | -See [patchwork/releases](https://github.com/ssbc/patchwork/releases) |
| 28 … | +Step 2 is important if you want to be able to find people further than your local network - it sets you up with a robot friend on the internet which helps you find and communicate with people. |
| 29 … | +Read more about Pubs and their role [here](./concepts/pub.md). |
| 26 | 30 … | |
| 27 | | -### Or Build from Source |
| 28 | 31 … | |
| 29 | | -With [node (>= 4) and npm (>= 2) installed](https://github.com/creationix/nvm): |
| 32 … | +### Build from Source |
| 30 | 33 … | |
| 31 | | -```shell |
| 32 | | -$ git clone https://github.com/ssbc/patchwork |
| 33 | | -$ cd patchwork |
| 34 | | -$ npm install |
| 35 | | -$ npm start |
| 36 | | -``` |
| 34 … | +This is more technical than the easy path, mainly useful if you're interested in developing Patchwork. |
| 37 | 35 … | |
| 38 | 36 … | On Linux you'll need some more dependencies. On Debian: |
| 39 | 37 … | |
| 40 | 38 … | ```shell |
| 41 | 39 … | sudo apt-get install libxext-dev libxtst-dev libxkbfile-dev g++ m4 automake libtool |
| 42 | 40 … | ``` |
| 43 | 41 … | |
| 44 | | -### Be Invited To A Pub |
| 42 … | +With [node (>= 4) and npm (>= 2) installed](https://github.com/creationix/nvm): |
| 45 | 43 … | |
| 46 | | -In order to gossip outside your local network, you'll need to connect to a [Pub](./concepts/pub.md). |
| 44 … | +```shell |
| 45 … | +$ git clone https://github.com/ssbc/patchwork |
| 46 … | +$ cd patchwork |
| 47 … | +$ npm install |
| 48 … | +$ npm start |
| 49 … | +``` |
| 47 | 50 … | |
| 48 | | -You can find an invite to an available pub at the [Pub servers registry](https://github.com/ssbc/scuttlebot/wiki/Pub-Servers). |
| 49 | 51 … | |
| 50 | | -Get an invite, then in `patchwork`: click "+ Join Pub" and paste the invite code. |
| 52 … | +Follow step (2) above to connect to the network. |
| 51 | 53 … | |
| 52 | | -This will cause you to follow the Pub and vise versa. If you haven't synchronized to this social network yet, prepare to wait a few minutes while your local server synchronizes. |
| 53 | | - |
| 54 | 54 … | ## Join The Community |
| 55 | 55 … | |
| 56 … | +Check out the following channels by typing their name (with #) in the search bar: |
| 56 | 57 … | - **#new-people**: introduce yourself |
| 57 | 58 … | - **#faq**: first impressions, what is confusing as a new user? |
| 58 | 59 … | - **#patchwork**: report bugs, suggestions, etc |
| 59 | 60 … | - **#scuttlebutt**: protocol related discussion |
| 60 | 61 … | |
| 62 … | +Here are some other favourites: |
| 63 … | +- **#boats**: people living on, hacking, and bulding boats |
| 64 … | +- **#cooking-channel**: nerds sharing recipes |
| 65 … | +- **#solarpunk**: step into the future |
| 66 … | +- **#gardening**: get some gardening on with your off-grid |
| 67 … | +- **#anarchitecture**: decentralise all the things |
| 68 … | + |
| 61 | 69 … | ## About This Handbook |
| 62 | 70 … | |
| 63 | 71 … | To view the public handbook, browse to [scuttlebutt.nz](https://www.scuttlebutt.nz) |
| 64 | 72 … | |