You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-65Lines changed: 16 additions & 65 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,14 @@
2
2
3
3
# Investing Algorithm Framework
4
4
5
-
The Investing Algorithm Framework is a free and open source Python framework that encourages rapid development and clean,
6
-
pragmatic design.
5
+
The Investing Algorithm Framework is a python framework to build investment algorithms. It encourages rapid development and clean,
6
+
pragmatic design. It is free for personal usage and open source.
7
7
8
-
The goal is to give you a configurable investing algorithm where you can decide how you implement your data providers,
9
-
strategies, and order executors.
8
+
In most cases, you'll probably never have to change code on this repo directly if you are building your own algorithm/bot. But if you do, check out CONTRIBUTING.md
10
9
11
-
#####Disclaimer
10
+
If you'd like to chat with investing-algorithm-framework users and developers, [join us on Slack](https://inv-algo-framework.slack.com)
11
+
12
+
#### Disclaimer
12
13
If you use this framework for your investments, do not risk money which you are afraid to lose. We can't stress this
13
14
enough:
14
15
@@ -18,81 +19,31 @@ YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR
18
19
Also, make sure that you read the source code of any plugin you use or implementation of an algorithm made with this
19
20
framework.
20
21
21
-
Documentation
22
-
------
23
-
All documentation is in the "docs" directory and online at "". If you're just getting started, here's how we recommend
24
-
you read the docs:
25
-
26
-
* First, read install for instructions on installing Investing Algorithm Framework.
27
-
* Next, work through the tutorials in order. ("Quickstart", "Template algorithm", "Custom algorithm").
28
-
* For concrete algorithm examples you probably want to read through the topical guides.
29
-
30
-
31
-
## Development branches
32
-
33
-
The project is currently setup in two main branches:
34
-
35
-
-`develop` - This branch has often new features, but might also cause breaking changes.
36
-
-`master` - This branch contains the latest stable release. The bot 'should' be stable on this branch, and is generally well tested.
37
-
-`feature/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.
38
-
-`hotfix/*` - These are hot fix branches, which are being worked on heavily. Please don't use these unless you really need to.
39
-
22
+
## Documentation
23
+
All documentation can be found online at "".
40
24
41
25
### Help / Slack
42
26
43
27
For any questions not covered by the documentation or for further
44
-
information about the bot, we encourage you to join our slack channel.
28
+
information about the framework, we encourage you to join our slack channel.
to understand the requirements before sending your pull-requests.
73
45
74
46
**Note** before starting any major new feature work, *please open an issue describing what you are planning to do* or talk to us on [Slack](https://join.slack.com/t/investingbots/shared_invite/enQtODgwNTg3MzA2MjYyLTdiZjczZDRlNWJjNDdmYThiMGE0MzFhOTg4Y2E0NzQ2OTgxYjA1NzU3ZWJiY2JhOTE1ZGJlZGFiNDU3OTAzMDg).
75
47
This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.
76
48
77
-
**Important:** Always create your PR against the `develop` branch, not `master`.
78
-
79
-
## Requirements
80
-
81
-
### Uptodate clock
82
-
The clock must be accurate, syncronized to a NTP server very frequently to avoid problems with communication to the exchanges.
83
-
84
-
### Min hardware required
85
-
86
-
To run this bot we recommend you a cloud instance with a minimum of:
87
-
88
-
- Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU
0 commit comments