If you only want to install and use TA-Lib, there is nothing here for you... check instead the main README.md file.
You must have python installed.
Modifications (or PR) must be made on the 'dev' branch.
Before committing, run scripts/sync.py to:
- Ensure your local dev branch is up-to-date with both remote dev and main branches.
- Do various check and fixes on your code (e.g. update "x.y.z" versioning in various files).
Merge to main branch are done with scripts/merge.py by TA-Lib maintainers with the proper permissions.
As needed, install dependencies:
$ sudo apt install automake libtool autogen mcpp
Build everything (includes gen_code and ta_regtest):
$ cd ta-lib
$ autoreconf -fi
$ ./configure
$ make
This will do all the needed autotools steps:
$ autoreconf -fi
Repeat whenever you need to refresh the makefiles.
$ cd ta-lib
$ mkdir build
$ cd build
$ cmake ..
$ make
Libraries will be in ta-lib/build and executable in ta-lib/bin
After make, call gen_code located in ta-lib/bin
Do this to refresh many files and code variant (Rust, Java etc...)
You should call ```make`` again after gen_code to verify if the potentially updated C code is still compiling.
After make, call ta_regtest located in ta-lib/src/tools
Exit code is 0 on success
Commit your source code changes in devs and... just let the Github action do all the repackaging for you.
The produced packages will be written in ta-lib/dist.
It may take up to one day for the CI to regenerate and test all for all platforms.
The rest of this section is only if you want to re-package locally.
You can call the scripts/package.py to generate the packages for your hosting platform.
You can test your packages with scripts/test-dist.py. This verifies from a TA-Lib user perspective. Notably, this simulates a ta-lib-python user.
Try to avoid pushing your generated packages to the TA-Lib repo, but do not worry if you do. As needed, they will get overwritten by the "nightly dev" Github action.
Any dev with permission to merge to main branch can do a release.
(1) On the dev branch, edit the VERSION file in the root of the repos.
(2) Run "./scripts/sync.py". This ensures your dev branch is up-to-date (among other things).
(3) Push to the dev branch.
(4) Wait up to one day for the "nightly dev" Github action to succeed. This will regenerate and test all the packages for all platforms. As needed, you can instead manually trig it.
(5) Merge dev into main with "./scripts/merge.py". At this point, the main branch is the release candidate with all the assets under "dist" folder.
(6) Wait up to one day for the "nightly main" Github action to succeed. This will perform a last check that all assets are OK. As needed, you can instead manually trig it.
(7) Manually trig the "publish-step-1" Github action on main branch. This will create the tag, draft release and attach all assets from the dist/ directory.
(8) Edit the draft Release notes on the Github website.
(9) Manually trig "publish-step-2" Github action. This will make the release public.
(10) Manually trig "publish-step-3". This will submit a PR to update homebrew for macOS users: https://github.com/Homebrew/homebrew-core/blob/30106807361198c58a395de65547694427adf229/Formula/t/ta-lib.rb