Update README DOCS #151
Update README DOCS #151
Conversation
|
|
||
| 3. Install the latest commit from the development branch | ||
| ```bash | ||
| pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development#egg=odm2api |
There was a problem hiding this comment.
What does the #egg=odm2api part do? I'm not familiar with that syntax. I've previously pip installed from a github branch using just this:
pip install git+https://github.com/ODM2/ODM2PythonAPI.git@development
There was a problem hiding this comment.
#egg is just a way to explicitly state project name. Not really needed when you do just a pip install, but does needed if doing pip install -e. See reference.
| 2. Create conda environment from the two text files. | ||
| ```bash | ||
| conda create -n odm2api_dev -c conda-forge python=2.7 --file requirements.txt --file requirements-dev.txt | ||
| ``` |
There was a problem hiding this comment.
Add statement to activate the new conda env, before the next instructions (pip install). As usual, this will have to list the instructions for Linux/MacOSX vs Windows.
README.md
Outdated
| wget https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/requirements-dev.txt | ||
| ``` | ||
|
|
||
| 2. Create conda environment from the two text files. |
There was a problem hiding this comment.
How about changing to this:
- Create conda environment
odm2api_devfrom the tworequirements*text files.
|
@lsetiawan I made a couple of suggestions for edits. If you agree with them, go ahead and implement them, then merge this PR yourself. Everything else looked good. Thanks! |
|
Also, why don't you go ahead and also address in this PR this comment I made last week:
To which you replied:
|
2 participants
Overview
Update README to reflect changes to
conda-forgechannel and how to install the latest development version.