mirror of
				https://github.com/avatao-content/test-tutorial-framework
				synced 2025-11-04 00:52:55 +00:00 
			
		
		
		
	Add documentation on tfw pip package
This commit is contained in:
		@@ -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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user