csingley/capgains

Is it possible to provide some documentation ?

girmax opened this issue · 2 comments

Is it possible to provide some documentation ?

This code, as it stands presently, is really only suitable for developers who want to hack on the code. If that doesn't describe you... if you're looking for a low-hassle plug&play solution... you should look elsewhere to satisfy your needs.

If you are looking to hack on this... what's (basically) finished here is the inventory subpackage. The flex importer (which reads Interactive Brokers transaction data and feeds it to inventory) is also pretty good. There's a few sharp corners, but they've had plenty of real-world data run through them, and their output has been checked by auditors. So the basic engine is pretty reliable.

At this point the only documentation is comments in the code. If that isn't giving you the picture, I could knock up some examples.

7xck commented

Sorry to revive this. I noticed you said you could knock up some examples, is that still seomthing you're willing to do? Thanks for your time.