Skip to content

Commit

Permalink
Update website content
Browse files Browse the repository at this point in the history
  • Loading branch information
mario4tier committed Oct 10, 2023
1 parent 3af20ca commit 6dec0aa
Show file tree
Hide file tree
Showing 10 changed files with 502 additions and 11 deletions.
13 changes: 7 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,11 @@ ta_regtest
desktop.ini

## User stuff...
/node_modules
/__pycache__
/venv
/.venv
node_modules
__pycache__
venv
.venv
.env

# Build files (from mkdocs)
/site
Expand All @@ -49,7 +50,7 @@ desktop.ini
TODO
tmp

## Editors
## Editors
*.swp
*.swo
Session.vim
Expand All @@ -66,4 +67,4 @@ Session.vim
*.pdb

# Never ignore .gitkeep files
!**/.gitkeep
!**/.gitkeep
442 changes: 442 additions & 0 deletions docs/api.md

Large diffs are not rendered by default.

Binary file added docs/assets/images/download32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/home-original.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/home.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
**Is TA-Lib maintained?**

Yes and No (depending of your perspective).

*The Good News*

Some projects depending on TA-Lib are still actively maintain.

The C/C++ source code have remained in-use for >20 years.

The C/C++ portion of TA-Lib is stable. Therefore, there is not much maintenance needed anymore.

*The Bad News*

The big **blocker** for applying a few minor fix to the code is the lack of resources (and interest) to maintain C/C++/binaries packaging for various OS/platforms. Also, the developer admit being afraid to touch it and have to suddenly support multiple platforms issues/limitation...

*The Plan*

Revive TA-Lib as a Rust package with Python bindings (using PyO3 Maturin).
These two languages have mature tooling for packaging and portable distribution.

There is hope that this will be easier to maintain by the community on long term.

Contact mario4tier on github if interested.

**Best place for support?**

Try these communities:

* [https://github.com/ta-lib/ta-lib-python](https://github.com/ta-lib/ta-lib-python)
* [https://github.com/twopirllc/pandas-ta](https://github.com/twopirllc/pandas-ta)
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ hide:
<figure markdown>
![TA-Lib](assets/images/home.png)
</figure>
<h3 align="center">Use TA-Lib to add technical analysis to your own financial market trading appplications</h3>
<h3 align="center">Use TA-Lib to add technical analysis to your own financial market trading applications</h3>

* Includes 200 indicators such as ADX, MACD, RSI, Stochastic, Bollinger Bands etc... [:octicons-arrow-right-24: See complete list...](functions.md)

* Candlestick pattern recognition

* Core written in [C/C++](api.md) with API also available for [Python](https://ta-lib.github.io/ta-lib-python/).
* Core written in [C/C++](api.md) with API also available for [Python](wrappers.md).

* Open-Source (BSD License). Can be freely integrated in your own open-source or commercial applications.

The code is stable and has passed the test of time. TA-Lib was release more than 20 years ago for well-known algorithms that are still widely in use today.
TA-Lib was release in 2021 for well-known algorithms that are still widely used >20 years later. The code is stable and have passed the test of time.
13 changes: 13 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Check [https://pypi.org/project/TA-Lib](https://pypi.org/project/TA-Lib)

Read the "dependencies" section for various installation and troubleshooting tips.


**Source Package (with makefiles):**

- [ta-lib-0.4.0-src.tar.gz](https://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz)

**Some variants:**

- Java [ta-lib-0.4.0.jar](https://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0.jar)
- RPM [ta-lib-0.4.0-1.i386.rpm](https://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-1.i386.rpm)
4 changes: 4 additions & 0 deletions docs/wrappers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Not satisfied with the C/C++ version? Please check these alternative projects that wrap and enhance TA-Lib:

* [ta-lib-python](https://github.com/ta-lib/ta-lib-python)
* [pandas-ta](https://github.com/twopirllc/pandas-ta)
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ nav:
- Docs:
- Functions List: functions.md
- C/C++ API: api.md
- Python, Rust and Other: wrappers.md
- Wrappers: wrappers.md
- FAQ: faq.md
- About Us: about.md
- About Us: about.md

0 comments on commit 6dec0aa

Please sign in to comment.