From 164c04459530adabb3132fbdd18513c4a9698c49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 8 Jun 2018 12:00:30 +0200 Subject: [PATCH] Reorder and augment stuff in readme --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1f2ba5d..52c2570 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,6 @@ Getting started with creating challenges using the framework – *setting up a d ## Setting up a development environment -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, 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 - git @@ -40,13 +28,24 @@ Dependencies: - Angular CLI - GNU coreutils -> You have trust issues regarding the public key infrastructure? You can request a checksum authenticated version of the installer command from our team! +Just copy and paste the following command in a terminal: + +`bash -c "$(curl -fsSL https://git.io/vxBfj)"` + +Please do not hesitate to contact us with error logs included should this command fail to complete. +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. This will set up a dev environment based on [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) just for you: - it builds the latest release of the framework Docker baseimage locally - it pins `solvable/Dockerfile` to use the this image - it includes the latest frontend in `solvable/frontend` with dependencies installed +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) + ## Building & running ### Automated