-
Notifications
You must be signed in to change notification settings - Fork 262
doc clarify full path needed for configs #16
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a great addition. some comments inline around consistency across the files.
@@ -41,9 +41,9 @@ A level defines a [layer](https://en.wikipedia.org/wiki/Layering_(finance)) that | |||
|
|||
## Run Kelp | |||
|
|||
Assuming your botConfig is called `trader.cfg` and your strategy config is called `buysell.cfg`, you can run `kelp` with the following command: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's keep the walkthrough files (buysell.md
, sell.md
, balanced.md
) consistent w.r.t. keeping/removing the following text:
you can run `kelp` with the following command
your PR only removed it from this file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That removal was supposed to be a revert to the original text when I simplified my change. I'll put it back here instead of removing it from the others.
I've implemented your consistency suggestions (thanks for the catch) and put the phrase about 'you can run....' back in the one file where I removed it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the changes, LGTM!
* cap3: 1 - implement liabilities for XLM * cap3: 2 - integrate liabilities into willOversell and willOverbuy methods * cap3: 3 - remove fractionalReserveMultiplier cli arg * cap3: 4 - offers in the same tx will contribute to liabilities, incorporate into cachedLiabilities * cap3: 5 - handle case of setting incrementalBuy for native asset * cap3: 6 - refactored willOversell and willOverbuy to extract common offer logic * cap3: 7 - added support for checking XLM fee and min reserves * cap3: 8 - update ordering of operations in strategies (sellSideStrategy, mirrorStrategy) when not all offers can be placed — always place inside orders first * cap3: 9 - native fee inclusion checks source/trader account usage * cap3: 10 - delete offer if nothing was created and we were planning to modify an existing offer * cap3: 11 - prepend deleteOps so we "free" up our liabilities capacity to place the new/modified offers * cap3: 12 - better error propagation from sdex.createModifySellOffer * cap3: 13 - extracted liability updates after placing/modifying offers to callers in sellSideStrategy and mirrorStrategy * cap3: 14 - prepend deleteOps for mirror strategy too * cap3: 15 - log liabilities in trader.go after resetting and after updating ops * cap3: 16 - add liabilities in mirror strat * cap3: 17 - added support for partial offers in sellSideStrategy, refactored updateSellLevel * cap3: 18 - updated comment when resetting cached liabilities * cap3: 19 - add current offer amounts to liabilities when not modifying an offer * cap3: 20 - add a caching layer for asset balances to reduce requests * cap3: 21 - cleaner logging of asset balance and trust amounts * cap3: 22 - let new capacity constraint system handle max limits for sellSideStrategy * cap3: 23 - reset caches before pruning and updating operations * cap3: 24 - update CHANGELOG * new release: v1.0.0-rc2 * expand assets allowed to use with the Kraken exchange, fixes stellar-deprecated#13 * new release: v1.0.0-rc3 * remove default rate offset percent from sample strategy config files * Print strat (stellar-deprecated#15) * Update trade.go * Update trade.go * Update trade.go * enable Travis CI, closes stellar-deprecated#17 (stellar-deprecated#18) * enable Travis CI * go_import_path * travis: ./bin/kelp version * doc clarify full path needed for configs (stellar-deprecated#16)
Edit trade examples to clarify that the full path to the file is required.
The examples at present don't make it clear that the path to the .cfg file is required for the config flags. This made it difficult for me as a new user to get started.