Commit 9e673d10e11b4387500655b63341d19c8108cc28
better documentation on how to find handbook source
Michael Williams committed on 4/7/2017, 1:48:28 AMParent: d9a1d68faaefed7a165b99168530e6ac68835727
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -48,12 +48,21 @@ | |||
| 48 | 48 … | 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. | |
| 49 | 49 … | ||
| 50 | 50 … | ## About This Handbook | |
| 51 | 51 … | ||
| 52 | -To view the public gitbook, browse to <http://scuttlebutt.nz>. | ||
| 52 … | +To view the public handbook, browse to <http://scuttlebutt.nz>. | ||
| 53 | 53 … | ||
| 54 | -You can also build and serve this with gitbook locally. The following assumes you're running a scuttlebot server and are in the follow neighbourhood of mixmix or his pub. | ||
| 54 … | +You can also build and serve this with gitbook locally. | ||
| 55 | 55 … | ||
| 56 … | + | ||
| 57 … | +The `SUMMARY.md` is the manifest on which the compiled gitbook is based. Edit that if you want content in/out of the book. | ||
| 58 … | + | ||
| 59 … | +### Contributing With `git-ssb` | ||
| 60 … | + | ||
| 61 … | +To use the public portal for the handbook code, browse to <https://git.scuttlebot.io/%25lJsDWwnF4bDxHWYuSjw%2FbW37xg%2BsaF8WtPZYZsefKj0%3D.sha256>. | ||
| 62 … | + | ||
| 63 … | +To use your local scuttlebot server to clone the handbook code: | ||
| 64 … | + | ||
| 56 | 65 … | ```bash | |
| 57 | 66 … | npm install git-ssb -g | |
| 58 | 67 … | git clone ssb://%lJsDWwnF4bDxHWYuSjw/bW37xg+saF8WtPZYZsefKj0=.sha256 ssb-handbook | |
| 59 | 68 … | ||
| @@ -61,12 +70,20 @@ | |||
| 61 | 70 … | npm install | |
| 62 | 71 … | npm start | |
| 63 | 72 … | ``` | |
| 64 | 73 … | ||
| 65 | -The `SUMMARY.md` is the manifest on which the compiled gitbook is based. Edit that if you want content in/out of the book. | ||
| 74 … | +To contribute to the handbook code, make a pull request with | ||
| 66 | 75 … | ||
| 67 | -> If you see a job that needs doing - that is your job. | ||
| 76 … | +``` | ||
| 77 … | +git ssb pull-request | ||
| 78 … | +``` | ||
| 68 | 79 … | ||
| 80 … | +### Contributing with GitHub | ||
| 81 … | + | ||
| 82 … | +Our public GitHub repository is at [ssbc/ssb-handbook](https://github.com/ssbc/ssb-handbook) | ||
| 83 … | + | ||
| 84 … | +Feel free to make an issue or pull request here if you see something that needs doing. | ||
| 85 … | + | ||
| 69 | 86 … | ## Other Projects | |
| 70 | 87 … | ||
| 71 | 88 … | Scuttlebutt is not the only project working in a decentralized space. Here are a few other projects also working on solutions: | |
| 72 | 89 … | ||
Built with git-ssb-web