d0zingcat/gocryptotrader
1
0
Fork 0
mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-06-05 15:10:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Applied fix to documentation.go for contribution HTML_URL.

Browse Source 
Added period to documentation templates sentences.
Added logic to documentation.go to fix broken links for godoc in sub-packages.
Fix coding style to conform to golang idiomatic practice.
Applied fix to access main godocs in tools and test data.
Generated new documents using tools.
This commit is contained in:
Ryan O'Hara-Reid
2018-02-20 11:56:25 +11:00
parent 51755d214b
commit dd00eba27e
40 changed files with 148 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
tools/README.md
View File

@@ -5,12 +5,12 @@
[![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/tools)
[![GoDoc](https://godoc.org/github.com/thrasher-/gocryptotrader?status.svg)](https://godoc.org/github.com/thrasher-/gocryptotrader/
[![Coverage Status](http://codecov.io/github/thrasher-/gocryptotrader/coverage.svg?branch=master)](http://codecov.io/github/thrasher-/gocryptotrader?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/thrasher-/gocryptotrader)](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader)
This tools package is part of the GoCryptoTrader codebase
This tools package is part of the GoCryptoTrader codebase.
## This is still in active development
@@ -20,7 +20,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
## Current Features
This folder contains an assortment of tools
This folder contains an assortment of tools.
+ Configuration
+ Documentation creation
@@ -29,10 +29,16 @@ This folder contains an assortment of tools
+ Websocket client
Example Run for documentation generation - flags -v Verbose & -R Replace files
```
Example Run for documentation generation - flags -v Verbose & -r Replace files
```sh
cd documentation/
go run documentation -v
go run documentation.go -v
```
OR for full replacement.
```sh
cd documentation/
go run documentation.go -v -r
```
## Contribution