Adding the CLI Style Guide (#530)

* initial change

* Fixed spinner gif image

* Fixed MD formatting typos

* Adding images for style guide

* Word and grammar changes from review

* Changed references to CLI in titles to Command Line Interface (CLI) and changed command-line to commane line (no hypen to be consistent)

* Typo fixes

* More typo fixes...

Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>
This commit is contained in:
Jake Haugen
2019-01-09 10:47:36 -07:00
committed by GitHub
parent a551fcc245
commit 115f5a3b1c
13 changed files with 251 additions and 4 deletions

View File

@@ -3,12 +3,12 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PegasysEng/pantheon/blob/master/LICENSE)
[ ![Download](https://api.bintray.com/packages/consensys/pegasys-repo/pantheon/images/download.svg) ](https://bintray.com/consensys/pegasys-repo/pantheon/_latestVersion)
[![Gitter chat](https://badges.gitter.im/PegaSysEng/pantheon.png)](https://gitter.im/PegaSysEng/pantheon)
Pantheon is an Apache 2.0 licensed, MainNet compatible, Ethereum client written in Java.
Pantheon is an Apache 2.0 licensed, MainNet compatible, Ethereum client written in Java.
## Pantheon Users
The process for installing and running Pantheon as a user is different to when developing. Some processes in our [user documentation](https://docs.pantheon.pegasys.tech/en/latest/) are different to those described in this Readme.
The process for installing and running Pantheon as a user is different to when developing. Some processes in our [user documentation](https://docs.pantheon.pegasys.tech/en/latest/) are different to those described in this Readme.
### Install and Run Pantheon
@@ -16,7 +16,7 @@ Installing and running Pantheon:
* [Installation]
* [Getting Started]
### Documentation
### Documentation
User and reference documentation available includes:
* [Command Line Options]
@@ -29,6 +29,7 @@ User and reference documentation available includes:
* [Contribution Guidelines](CONTRIBUTING.md)
* [Coding Conventions](CODING-CONVENTIONS.md)
* [Command Line Interface (CLI) Style Guide](CLI-STYLE-GUIDE.md)
* [User Documentation] for running and using Pantheon
### Development