Commit 62d6ec3f6ae3b369ebf676f26335550809aa3de2
update README
mix irving committed on 9/11/2017, 6:31:29 AMParent: 20b068c61874ad0cae6afbd9ab2ffefe1fb2f74c
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -10,9 +10,9 @@ | ||
| 10 | 10 … | |
| 11 | 11 … | |
| 12 | 12 … | ## Setup |
| 13 | 13 … | |
| 14 | -Libsodium has some build dependencies. On *ubuntu systems the following might help: | |
| 14 … | +Libsodium has some build dependencies. On ubuntu systems the following might help: | |
| 15 | 15 … | |
| 16 | 16 … | ```sh |
| 17 | 17 … | sudo apt-get install m4 libtool eclipse-cdt-autotools |
| 18 | 18 … | ``` |
| @@ -21,13 +21,40 @@ | ||
| 21 | 21 … | ```sh |
| 22 | 22 … | brew install libtool automake autoconf |
| 23 | 23 … | ``` |
| 24 | 24 … | |
| 25 | -Install Scuttlebot (your gossip server) | |
| 25 … | +### Easy Install | |
| 26 | 26 … | |
| 27 … | +This runs an embedded sbot with all the right plugins already installed. | |
| 28 … | + | |
| 27 | 29 … | ```sh |
| 30 … | +git clone https://github.com/ssbc/patchbay.git | |
| 31 … | +cd patchbay | |
| 32 … | +npm install | |
| 33 … | +npm run rebuild | |
| 34 … | +``` | |
| 35 … | + | |
| 36 … | +Patchbay doesn't give you a way to join pubs yet, so this is good if you've already done that with another client (like Patchwork). | |
| 37 … | + | |
| 38 … | + | |
| 39 … | +### Harder Install (full dev setup) | |
| 40 … | + | |
| 41 … | +Install a standalone scuttlebot (your gossip server) | |
| 42 … | +```sh | |
| 28 | 43 … | npm install scuttlebot@latest -g |
| 44 … | +``` | |
| 29 | 45 … | |
| 46 … | +Until https://github.com/ssbc/scuttlebot/pull/417 is resolved, you may need to do this instead: | |
| 47 … | + | |
| 48 … | +```sh | |
| 49 … | +git clone https://github.com/ssbc/scuttlebot.git | |
| 50 … | +cd scuttlebot | |
| 51 … | +git checkout ssb-private | |
| 52 … | +npm install | |
| 53 … | +npm link // this should make sbot accessible globally | |
| 54 … | +``` | |
| 55 … | + | |
| 56 … | +```sh | |
| 30 | 57 … | # make sure you have secure-scuttlebutt@15.5.2 |
| 31 | 58 … | npm ls secure-scuttlebutt -g |
| 32 | 59 … | |
| 33 | 60 … | sbot server |
| @@ -41,31 +68,37 @@ | ||
| 41 | 68 … | # restart sbot server (go back to previous tab and kill it) |
| 42 | 69 … | ``` |
| 43 | 70 … | |
| 44 | 71 … | Restart your sbot, then (optionally) use an invite code. This will give you your first friend, from which point you can find others: |
| 72 … | +```sh | |
| 73 … | +sbot invite.accept LONG_INVITE_CODE_MAYBE_IN_QUOTES | |
| 45 | 74 … | ``` |
| 46 | - sbot invite.accept LONG_INVITE_CODE_MAYBE_IN_QUOTES | |
| 47 | -``` | |
| 48 | 75 … | |
| 49 | -Install Patchbay (an interface for the your scuttlebutt database) | |
| 50 | - | |
| 76 … | +Install Patchbay | |
| 51 | 77 … | ```sh |
| 52 | 78 … | git clone https://github.com/ssbc/patchbay.git |
| 53 | 79 … | cd patchbay |
| 54 | 80 … | npm install |
| 55 | -npm run setup | |
| 56 | 81 … | npm run rebuild |
| 57 | 82 … | ``` |
| 58 | 83 … | |
| 59 | - | |
| 60 | 84 … | ## Running the desktop app |
| 61 | 85 … | |
| 62 | -From inside the patchbay repo folder, | |
| 63 | 86 … | |
| 87 … | +Easy mode (embedded sbot): | |
| 64 | 88 … | ```sh |
| 89 … | +# from the patchbay repo folder | |
| 65 | 90 … | npm start |
| 66 | 91 … | ``` |
| 67 | 92 … | |
| 93 … | +Harder mode: | |
| 94 … | +```sh | |
| 95 … | +sbot server | |
| 96 … | + | |
| 97 … | +# from the patchbay repo folder | |
| 98 … | +npm run dev | |
| 99 … | +``` | |
| 100 … | + | |
| 68 | 101 … | ## How to add a feature |
| 69 | 102 … | |
| 70 | 103 … | To add a new message type, add add a js to `./modules/` that exports a function named `message_content` (it should return an HTML element). To add a new tab, export a function named `screen_view` (returns an html element). |
| 71 | 104 … | |
| @@ -75,13 +108,10 @@ | ||
| 75 | 108 … | |
| 76 | 109 … | |
| 77 | 110 … | ## Module graph |
| 78 | 111 … | |
| 79 | -patchbay uses [depject](http://github.com/dominictarr/depject) to manage it's modules. Here is a graph of the current connections between them (round shows module, square shows api, arrow direction points from user to provider). | |
| 112 … | +TODO - reinstate this | |
| 80 | 113 … | |
| 81 | -[module graph](./graph.svg) | |
| 82 | - | |
| 83 | - | |
| 84 | 114 … | ## License |
| 85 | 115 … | |
| 86 | 116 … | MIT |
| 87 | 117 … | |
Built with git-ssb-web