Commit 69094b14d8a0f96b5da1d4ce1008b7ba2ceb94d3
Merge pull request #11 from carlthuringer/reaadme-requirements
Git and Node are requirements for installation.Henry authored on 9/4/2018, 4:45:25 PM
GitHub committed on 9/4/2018, 4:45:25 PM
Parent: cbb9a71cc7c3b5e5af5a55d7a71a1f0baff8c58b
Parent: 5a0419f6c2662e881e7cb6c76d64e1b5b1f55de7
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -1,12 +1,16 @@ | |||
| 1 | 1 … |  | |
| 2 | 2 … | ||
| 3 | -# Scuttle Shell | ||
| 3 … | +# Scuttle Shell | ||
| 4 | 4 … | ||
| 5 | 5 … | This is a [Secure Scuttlebutt](http://scuttlebutt.nz) system tray application. It provides an always-running _sbot_ for your local system. | |
| 6 | 6 … | ||
| 7 | 7 … | This app also setups itself as a [Native Host App](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging) that can be used by **authorized Firefox Add-ons** such as [Patchfox](https://github.com/soapdog/patchfox). | |
| 8 | 8 … | ||
| 9 … | +## Dependencies | ||
| 10 … | + | ||
| 11 … | +You must have [Git](https://git-scm.com) and [Node](https://nodejs.org) installed. | ||
| 12 … | + | ||
| 9 | 13 … | ## Install globally | |
| 10 | 14 … | ||
| 11 | 15 … | ``` | |
| 12 | 16 … | $ npm install -g scuttle-shell | |
| @@ -14,9 +18,9 @@ | |||
| 14 | 18 … | ||
| 15 | 19 … | or if you cloned this repo (run from the repo folder itself): | |
| 16 | 20 … | ||
| 17 | 21 … | ``` | |
| 18 | -$ npm install -g | ||
| 22 … | +$ npm install -g | ||
| 19 | 23 … | ``` | |
| 20 | 24 … | ||
| 21 | 25 … | You can run the app by executing `scuttleshell` on your terminal. | |
| 22 | 26 … | ||
| @@ -42,10 +46,10 @@ | |||
| 42 | 46 … | ``` | |
| 43 | 47 … | ||
| 44 | 48 … | This should set it up. If anything fails you can check your setup with | |
| 45 | 49 … | ||
| 50 … | +### Checking your setup | ||
| 46 | 51 … | ||
| 47 | -### Checking your setup | ||
| 48 | 52 … | Depending on your running operating system, you can check the configuration using: | |
| 49 | 53 … | ||
| 50 | 54 … | ``` | |
| 51 | 55 … | $ npm run check | |
| @@ -57,9 +61,10 @@ | |||
| 57 | 61 … | $ npm run check-win | |
| 58 | 62 … | ``` | |
| 59 | 63 … | ||
| 60 | 64 … | ### Running Setup (again) | |
| 65 … | + | ||
| 61 | 66 … | If anything went wrong during the setup or if you rename the folder this app is in, you can redo the setup with: | |
| 62 | 67 … | ||
| 63 | 68 … | ``` | |
| 64 | 69 … | $ npm install | |
| 65 | -``` | ||
| 70 … | +``` | ||
Built with git-ssb-web