Skip to content

Commit b0e13f9

Browse files
committed
Fix doc page references
1 parent c4028cd commit b0e13f9

File tree

27 files changed

+7016
-228
lines changed

27 files changed

+7016
-228
lines changed

docusaurus/docs/Contributing Guide/contributing.md

Lines changed: 638 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Contributing Guide/style-guide.md

Lines changed: 900 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Data/download.md

Lines changed: 554 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Data/market-data-sources.md

Lines changed: 556 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Data/multiple-market-data-sources.md

Lines changed: 856 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Getting Started/application-setup/index.html

Lines changed: 0 additions & 25 deletions
This file was deleted.

docusaurus/docs/Getting Started/backtesting/index.html

Lines changed: 0 additions & 23 deletions
This file was deleted.

docusaurus/docs/Getting Started/deployment.md

Lines changed: 520 additions & 0 deletions
Large diffs are not rendered by default.

docusaurus/docs/Getting Started/deployment/index.html

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Installation
6+
7+
Get started with the Investing Algorithm Framework by following these simple installation steps.
8+
9+
## Prerequisites
10+
11+
Before installing the framework, ensure you have:
12+
13+
- **Python 3.10+** installed on your system
14+
- **pip** (Python package installer)
15+
- **git** (for cloning repositories)
16+
17+
## Installation Options
18+
19+
### Option 1: Install from PyPI (Recommended)
20+
21+
Install the latest stable version from PyPI:
22+
23+
```bash
24+
pip install investing-algorithm-framework
25+
```
26+
27+
### Option 2: Install from Source
28+
29+
For the latest development version, install directly from GitHub:
30+
31+
```bash
32+
pip install git+https://github.com/coding-kitties/investing-algorithm-framework.git
33+
```
34+
35+
### Option 3: Development Installation
36+
37+
If you plan to contribute to the framework:
38+
39+
1. **Clone the repository:**
40+
```bash
41+
git clone https://github.com/coding-kitties/investing-algorithm-framework.git
42+
cd investing-algorithm-framework
43+
```
44+
45+
2. **Install in development mode:**
46+
```bash
47+
pip install -e .
48+
```
49+
50+
## Next Steps
51+
52+
Once installation is complete, proceed to [Application Setup](application-setup) to create your first trading application!

0 commit comments

Comments
 (0)