mrtoth
/
test-tutorial-framework
mirror of https://github.com/avatao-content/test-tutorial-framework
1
0
Fork 0
Code Issues Releases Wiki Activity

Add documentation on tfw pip package

This commit is contained in:
Kristóf Tóth 2018-05-10 17:22:27 +02:00
parent 9eede5f80e
commit ba0f92d2ac
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -24,7 +24,13 @@ Just copy and paste the following command in a terminal:
`bash -c "$(curl -fsSL https://git.io/vxBfj)"`
Note that your SSH public key must be added to your GitHub user for this to work.
Note that your SSH public key must be added to your GitHub user for this to work, or you mush select HTTPS remotes when prompted.
By default your IDE will fail to autocomplete code and will complain about missing dependencies.
To fix this you should install the `tfw` pip package in your dev virtualenv:
- `pip install git+ssh://git@github.com/avatao-content/baseimage-tutorial-framework.git` (SSH)
- `pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.git` (HTTPS)
Dependencies:
- bash