Skip to content

Commit 1220c1f

Browse files
authored
Update README.md
1 parent dde1ccb commit 1220c1f

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ First an overview of any Portfolio-Position in every Account is displayed (only
99
You can select all Accounts. Basic information, such as *NetLiquidation*, the used *Margin* and *Available Cash* are shown. All Portfolio-Positions (Contracts) are displayed.
1010

1111

12-
A *Simple Form* to place an emergency-order (i.e. a "Close-Position"-Feature) is provided, too. New Positions can be established through their basic properties (see below). In practice, one would use the [Watchlist](ib-ruby/ib-ruby/wiki/Watchlists) feature
13-
of **`IB-Ruby`** to provide additional Contracts.
12+
A *Simple Form* to place an emergency-order (i.e. a "Close-Position"-Feature) is provided, too. New Positions can be established through their basic properties (see below). In practice, one would use the [Watchlist](https://ib-ruby.github.io/ib-doc/watchlists.html) feature to provide additional Contracts.
1413

1514
#### Getting Started
1615

16+
* **Setup your environment through [IB-Container](https://github.com/ib-ruby/ib-container).**
17+
18+
or
19+
1720
* Install Ruby 2.6+ (via rvm), tmux and elinks.
1821

1922
* clone this repository ( `git clone https://guthub.com/ib-ruby/simple-monitor.git` )
@@ -23,7 +26,7 @@ of **`IB-Ruby`** to provide additional Contracts.
2326

2427
* Start a TWS or a Gateway (TWS must fullfil the requirements of ›› [IB-RUBY]( https://ib-ruby.github.io/ib-doc/) ‹‹).
2528

26-
* Edit `tws-alias.yml` and change the `:host`-Entry to the host running the TWS/Gateway (eg. `localhost:7496`).
29+
* Edit `config.yml` and change the `:host`-Entry to the host running the TWS/Gateway (eg. `localhost:7496`).
2730
If a connection is made with the Gateway, specify that port, too, eg `localhost:4001`. If no Account-Alias is set in
2831
Account-Management, local Aliases can be specified in the yaml-dataset.
2932

@@ -47,7 +50,7 @@ If a User is selected or only one User is present, a detail-page is displayed
4750
![Screenshot](simple-monitor_detail.png)
4851

4952
#### Tmux Startup Script
50-
First edit `./start-_simple-monitor` and check if the provided pathes fit your environment.
53+
First edit `./start-simple-monitor` and check if the provided pathes fit your environment.
5154

5255
This is the expected output
5356
![Screenshot](simple-monitor-tmux.png)

0 commit comments

Comments
 (0)