Skip to content
This repository has been archived by the owner on Apr 30, 2020. It is now read-only.

Commit

Permalink
add chinese docs
Browse files Browse the repository at this point in the history
  • Loading branch information
miaolz123 committed Dec 30, 2016
1 parent a408523 commit 141b935
Show file tree
Hide file tree
Showing 5 changed files with 422 additions and 13 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

[![Travis](https://img.shields.io/travis/miaolz123/samaritan.svg)](https://travis-ci.org/miaolz123/samaritan) [![Go Report Card](https://goreportcard.com/badge/github.com/miaolz123/samaritan)](https://goreportcard.com/report/github.com/miaolz123/samaritan) [![Github All Releases](https://img.shields.io/github/downloads/miaolz123/samaritan/total.svg)](https://github.com/miaolz123/samaritan/releases) [![Docker Pulls](https://img.shields.io/docker/pulls/miaolz123/samaritan.svg)](https://hub.docker.com/r/miaolz123/samaritan/) [![license](https://img.shields.io/github/license/miaolz123/samaritan.svg)](https://github.com/miaolz123/samaritan/blob/master/LICENSE)

[中文文档](http://samaritan.stockdb.org/#/zh-cn)

## Installation

You can install samaritan from **installation package** or **docker**.
You can install samaritan from **installation package** or **Docker**.

The default username and password are `admin`, please modify them immediately after login!

Expand All @@ -20,9 +22,9 @@ Then, samaritan is running at `http://localhost:9876`.
**Linux & Mac user quick start command**

```shell
wget https://github.com/miaolz123/samaritan/releases/download/v{{VERSION}}/samaritan_{{OS}}_{{ARCH}}.tar.gz && \
tar -xzvf samaritan_{{OS}}_{{ARCH}}.tar.gz.tar.gz && \
cd samaritan_{{OS}}_{{ARCH}} && \
wget https://github.com/miaolz123/samaritan/releases/download/v{{VERSION}}/samaritan_{{OS}}_{{ARCH}}.tar.gz
tar -xzvf samaritan_{{OS}}_{{ARCH}}.tar.gz
cd samaritan_{{OS}}_{{ARCH}}
./samaritan
```

Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Installation

You can install samaritan from **installation package** or **docker**.
You can install samaritan from **installation package** or **Docker**.

The default username and password are `admin`, please modify them immediately after login!

Expand Down Expand Up @@ -50,21 +50,21 @@ Then, samaritan is running at `http://localhost:19876`.

### Add an Exchange

![](http://samaritan.stockdb.org/_media/add-exchange.png)
![](https://raw.githubusercontent.com/miaolz123/samaritan/master/docs/_media/add-exchange.png)

### Add an Algorithm

![](http://samaritan.stockdb.org/_media/add-algorithm.png)
![](https://raw.githubusercontent.com/miaolz123/samaritan/master/docs/_media/add-algorithm.png)

![](http://samaritan.stockdb.org/_media/edit-algorithm.png)
![](https://raw.githubusercontent.com/miaolz123/samaritan/master/docs/_media/edit-algorithm.png)

### Deploy an Algorithm

![](http://samaritan.stockdb.org/_media/add-trader.png)
![](https://raw.githubusercontent.com/miaolz123/samaritan/master/docs/_media/add-trader.png)

### Run a Trader

![](http://samaritan.stockdb.org/_media/run-trader.png)
![](https://raw.githubusercontent.com/miaolz123/samaritan/master/docs/_media/run-trader.png)

# Algorithm Reference

Expand Down
2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<br>

> A quantitative trading framework for auto-trading digital currency.
> An Algorithmic Trading Framework for Digital Currency.
<br>

Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
<!--<nav>
<nav>
<a href="#/">English</a>
<a href="#/zh-cn">中文</a>
</nav>-->
</nav>
<div id="app"></div>
</body>
<script
Expand Down
Loading

0 comments on commit 141b935

Please sign in to comment.