Fix code style link in readme to point to contributing doc (#223)

* Fix code style link in readme to point to contributing doc

* Update documentation tool template files and regenerated documentation
This commit is contained in:
Dan Bent
2018-12-20 12:54:00 +13:00
committed by Adrian Gallagher
parent ff6a84f0f1
commit 2993ae17cf
5 changed files with 36 additions and 58 deletions

View File

@@ -83,7 +83,7 @@ When submitting a PR, please abide by our coding guidelines:
+ Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
+ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md).
+ Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/.github/CONTRIBUTING.md).
+ Pull requests need to be based on and opened against the `master` branch.
## Compiling instructions
@@ -93,39 +93,24 @@ platform.
### Linux/OSX
We use the `dep` tool provided by Golang for managing dependencies. As it is not officially part
of the go tools package suite, you will need to manually install it if you have not already.
On MacOS you can install or upgrade to the latest released version with Homebrew:
```sh
brew install dep
brew upgrade dep
```
On linux or MacOS, you can also install it via `go get`:
```sh
go get -u github.com/golang/dep/cmd/dep
```
After `dep` is installed, please follow the instructions below:
GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above
Using Go Modules you now clone this repository **outside** your GOPATH
```bash
go get github.com/thrasher-/gocryptotrader
cd $GOPATH/src/github.com/thrasher-/gocryptotrader
make get
make install
cp $GOPATH/src/github.com/thrasher-/gocryptotrader/config_example.json $GOPATH/bin/config.json
git clone https://github.com/thrasher-/gocryptotrader.git
cd gocryptotrader
go build
mkdir ~/.gocryptotrader
cp config_example.json ~/.gocryptotrader/config.json
```
### Windows
```bash
go get github.com/thrasher-/gocryptotrader
cd %GOPATH%\src\github.com\thrasher-\gocryptotrader
go install
copy %GOPATH%\src\github.com\thrasher-\gocryptotrader\config_example.json %GOPATH%\bin\config.json
git clone https://github.com/thrasher-/gocryptotrader.git
cd gocryptotrader
go build
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
```
+ Make any neccessary changes to the `config.json` file.

View File

@@ -1,13 +1,8 @@
{{define "web" -}}
{{template "header" .}}
## Current Features
+ It can run
+ It can be compiled with Electron to run as an executable
+ Websocket support to listen to GoCryptoTrader events
+ Material design
+ Has a semi-working Settings page
+ Has a basic ticker dashboard
# The Angular version of the front-end is being replaced by a React implementation on this branch: https://github.com/thrasher-/gocryptotrader/tree/react-web/web
### There will be no further development on the Angular front end and all development should be directed to the new branch until it is merged.
## Install dependencies with npm
@@ -30,11 +25,7 @@ npm run start:web
Currently runs with:
- Angular v6.0.9
- Angular-CLI v6.0.8
- Electron v1.8.7
- Electron Builder v20.0.4
- Angular v7
## To build for production