Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to provide some documentation ? #1

Open
girmax opened this issue Dec 14, 2020 · 2 comments
Open

Is it possible to provide some documentation ? #1

girmax opened this issue Dec 14, 2020 · 2 comments

Comments

@girmax
Copy link

girmax commented Dec 14, 2020

No description provided.

@csingley
Copy link
Owner

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
Copy link

7xck commented May 20, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants