d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-14 07:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTORS
View File

@@ -8,13 +8,16 @@ ermalguni | https://github.com/ermalguni
marcofranssen | https://github.com/marcofranssen
cranktakular | https://github.com/cranktakular
crackcomm | https://github.com/crackcomm
andreygrehov | https://github.com/andreygrehov
bretep | https://github.com/bretep
gam-phon | https://github.com/gam-phon
cornelk | https://github.com/cornelk
if1live | https://github.com/if1live
soxipy | https://github.com/soxipy
herenow | https://github.com/herenow
andreygrehov | https://github.com/andreygrehov
xtda | https://github.com/xtda
blombard | https://github.com/blombard
CodeLingoBot | https://github.com/CodeLingoBot
daniel-cohen | https://github.com/daniel-cohen
frankzougc | https://github.com/frankzougc
starit | https://github.com/starit
@@ -27,7 +30,4 @@ m1kola | https://github.com/m1kola
cavapoo2 | https://github.com/cavapoo2
tongxiaofeng | https://github.com/tongxiaofeng
idealhack | https://github.com/idealhack
vyloy | https://github.com/vyloy
askew- | https://github.com/askew-
whilei | https://github.com/whilei

20
README.md
View File

@@ -82,7 +82,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,12 +93,12 @@ platform.
### Linux/OSX
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
Using Go Modules you now clone this repository **outside** your GOPATH
```bash
git clone https://github.com/thrasher-/gocryptotrader.git
cd gocryptotrader
go build
go build
mkdir ~/.gocryptotrader
cp config_example.json ~/.gocryptotrader/config.json
```
@@ -133,21 +133,24 @@ Binaries will be published once the codebase reaches a stable condition.
|User|Github|Contribution Amount|
|--|--|--|
| thrasher- | https://github.com/thrasher- | 482 |
| shazbert | https://github.com/shazbert | 151 |
| gloriousCode | https://github.com/gloriousCode | 132 |
| thrasher- | https://github.com/thrasher- | 489 |
| shazbert | https://github.com/shazbert | 156 |
| gloriousCode | https://github.com/gloriousCode | 139 |
| ermalguni | https://github.com/ermalguni | 14 |
| 140am | https://github.com/140am | 8 |
| marcofranssen | https://github.com/marcofranssen | 8 |
| cranktakular | https://github.com/cranktakular | 5 |
| crackcomm | https://github.com/crackcomm | 3 |
| andreygrehov | https://github.com/andreygrehov | 2 |
| bretep | https://github.com/bretep | 2 |
| gam-phon | https://github.com/gam-phon | 2 |
| cornelk | https://github.com/cornelk | 2 |
| if1live | https://github.com/if1live | 2 |
| soxipy | https://github.com/soxipy | 2 |
| herenow | https://github.com/herenow | 2 |
| andreygrehov | https://github.com/andreygrehov | 1 |
| xtda | https://github.com/xtda | 1 |
| blombard | https://github.com/blombard | 1 |
| CodeLingoBot | https://github.com/CodeLingoBot | 1 |
| daniel-cohen | https://github.com/daniel-cohen | 1 |
| frankzougc | https://github.com/frankzougc | 1 |
| starit | https://github.com/starit | 1 |
@@ -160,9 +163,6 @@ Binaries will be published once the codebase reaches a stable condition.
| cavapoo2 | https://github.com/cavapoo2 | 1 |
| tongxiaofeng | https://github.com/tongxiaofeng | 1 |
| idealhack | https://github.com/idealhack | 1 |
| vyloy | https://github.com/vyloy | 1 |
| askew- | https://github.com/askew- | 1 |
| whilei | https://github.com/whilei | 1 |

39
tools/documentation/root_templates/root_readme.tmpl
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.

15
tools/documentation/web_templates/web_readme.tmpl
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

12
web/README.md
View File

@@ -1,10 +1,8 @@
## The Angular version of the front-end is being replaced by a React implemtnation on this branch: https://github.com/thrasher-/gocryptotrader/tree/react-web/web
# GoCryptoTrader package Web
<img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
[![Build Status](https://travis-ci.org/thrasher-/gocryptotrader.svg?branch=master)](https://travis-ci.org/thrasher-/gocryptotrader)
[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/web)
@@ -12,13 +10,18 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
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.
This web package is part of the GoCryptoTrader codebase.
## This is still in active development
You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader).
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://gocryptotrader.herokuapp.com/)
# 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
``` bash
@@ -42,7 +45,6 @@ Currently runs with:
- Angular v7
## To build for production
- **in a terminal window** -> npm start