Modified the README.md with updated installation instruction. #88
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@femtotrader, @ryankennedyio - Are you happy with the new README.md? |
|
|
||
| # Installation and Usage | ||
| Ubuntu is the recommended platform on which to install QSTrader, but it will also work on Windows or Mac OSX under the Anaconda distribution (). |
There was a problem hiding this comment.
Unnecessary parentheses maybe?
|
Only other thing I might suggest is some info on how to analyse/view the .pkl files that are generated? Otherwise, good good. Maybe some tips about generating and passing in the config file as a Click parameter, but don't think necessary at this stage, as anyone running it will be diving pretty deep into the code anyway. |
|
Yeah, I think for the time being I'll ignore the Click parameter discussion. It might overcomplicate it for some users at this stage. Hopefully once we package it up via PyPI then the installation will be far easier. |
|
|
||
| ``` | ||
| source ~/venv/qstrader/bin/activate | ||
| pip install -r ~/projects/qstrader/requirements.txt | ||
| pip install git+git://github.com/mhallsmoore/qstrader.git |
There was a problem hiding this comment.
I think
$ pip install git+git://
should be
$ pip install git+https://
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.