summarylogtreecommitdiffstats
path: root/README.md
blob: 59ffe24a36c082bc009f6774b5462f2a53cb03a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
ib-tws Package Helpers
======================

Source and helpers for the [Interactive Brokers]
(http://interactivebrokers.com/) Traders Workstation [ib-tws]
(https://aur.archlinux.org/packages/ib-tws/) AUR package.

This project assists maintain ib-tws. It is necessary because TWS is
downloaded from a generic, non-versioned URL. The downloaded file does
not provide a version number, instead requiring execution of the software
to determine the version. These conditions complicate maintenance of the
Arch package, as the package must report the correct TWS version number
plus reflect the md5sum of the currently-available TWS URL.

Setup
-----

Install software:

     sudo pacman -S wget java-environment bash base-devel namcap pkgbuild-introspection

From the Git cloned ib-tws directory, add symbolic links for the utilities:

     ln -s `pwd`/tws_scripts/tws_get_version $HOME/bin/tws_get_version
     ln -s `pwd`/tws_scripts/tws_check_update $HOME/bin/tws_check_update

Verify correct execution by running `tws_check_update`. It should report
a TWS version number and store files in `$HOME/.tws_scripts/`.

Usage
-----

If you *are not* the current AUR maintainer, run `update`. This will:

* Run `tws_check_update`
* Update the `PKGBUILD` to reflect the reported version and hash codes
* Build the package, including a source version
* Run `namcap` to verify package quality (the build will fail if any
  warnings are reported)

If you *are* the current AUR maintainer, run `upload`. This will:

* Run `update` (refer above)
* If any changes were made, a Git commit and push is performed

If you are the current AUR maintainer but used `tws_check_update` and it
updated the version, simply `rm $HOME/.tws_scripts/` and use `upload`.

License
-------

All contents of this repository are provided under the
[Apache License, Version 2.0]
(https://www.apache.org/licenses/LICENSE-2.0.html).