Cleanup docs before testnet2 (#798)

* move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page)
* Update doc/style and move it into CONTRIBUTING.
* group up docs overview for more clarity
* link to previously unlinked content in the docs overview
* update + cleanup doc/build
* Update links to reflect troubleshooting is now only in the wiki
* More link fixes and spelling
* Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead
* Last forgotten CONTRIBUTING.md fix
This commit is contained in:
Simon B
2018-03-17 19:08:40 +01:00
committed by Ignotus Peverell
parent 2fb97eb87f
commit 7c3994e521
7 changed files with 175 additions and 280 deletions
+46 -3
View File
@@ -13,8 +13,51 @@ Find us:
* Chat: [Gitter](https://gitter.im/grin_community/Lobby).
* Mailing list: join the [~MimbleWimble team](https://launchpad.net/~mimblewimble) and subscribe on Launchpad.
## Style Guide
# Grin Style Guide
For info on the Grin style guide, see the [style docs](doc/style.md).
Grin uses `rustfmt` to maintain consistent formatting.
Please use the git commit hook as explained below.
Grin leverages `rustfmt` to maintain consistent formatting (and a [git commit hook](doc/style.md) to run it).
## Install rustfmt
You should use rustup. See [build docs](doc/build.md) for more info.
```
rustup component add rustfmt-preview
rustup update
rustfmt --version
```
and verify you did get version `0.3.4-nightly (6714a44 2017-12-23)` or newer.
## Install git pre-commit hook
There is a basic git [pre-commit](../.hooks/pre-commit) hook in the repo.
The pre-commit hook will not prevent commits if style issues are present but it will
indicate any files that need formatting.
To enable this, create a symlink in `.git/hooks` (note the relative path) -
```
cd .git/hooks
ln -s -f ../../.hooks/pre-commit
```
## Running rustfmt
You can run rustfmt (i.e. rustfmt-preview) on one file or on all files.
First try a dry-run on a file you've worked on, say:
`rustfmt --write-mode diff -- client.rs`
Any errors or rustfmt failures? Fix those manually.
Then let rustfmt make any further changes and save you the work:
`rustfmt --write-mode overwrite -- client.rs`
*Please add the rustfmt corrections as a separate commit at the end of your Pull Request to make the reviewers happy.*
And don't use ~~`cargo +nightly fmt`~~ if at all possible.