From 29b06e7ecd26b9bf567ef9abd7425c342ec440be Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Thu, 5 Sep 2013 12:50:06 -0300 Subject: Update docs for testers and bootstrap script. --- docs/testers/howto.rst | 8 +++--- docs/user/install.rst | 2 ++ pkg/scripts/bitmask_bootstrap.sh | 49 +++++++++++++++++++++++++++++++++++ pkg/scripts/leap_client_bootstrap.sh | 50 ------------------------------------ 4 files changed, 55 insertions(+), 54 deletions(-) create mode 100644 pkg/scripts/bitmask_bootstrap.sh delete mode 100644 pkg/scripts/leap_client_bootstrap.sh diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst index dde893d1..9c6561ed 100644 --- a/docs/testers/howto.rst +++ b/docs/testers/howto.rst @@ -19,7 +19,7 @@ To allow rapid testing in different platforms, we have put together a quick scri .. note:: - In the near future, we will be using ``standalone bundles`` with the ability to self-update. + In the near future, we will be using :ref:`standalone bundles ` with the ability to self-update. Install dependencies ^^^^^^^^^^^^^^^^^^^^ @@ -41,8 +41,8 @@ Download and source the following script in the parent folder where you want you .. code-block:: bash cd /tmp - wget https://raw.github.com/leapcode/bitmask/develop/pkg/scripts/leap_client_bootstrap.sh - source leap_client_bootstrap.sh + wget https://raw.github.com/leapcode/leap_client/develop/pkg/scripts/bitmask_bootstrap.sh + source bitmask_bootstrap.sh Tada! If everything went well, you should be able to run bitmask by typing:: @@ -52,7 +52,7 @@ Noticed that your prompt changed? That was *virtualenv*. Keep reading... Activating the virtualenv ^^^^^^^^^^^^^^^^^^^^^^^^^ -The above bootstrap script has fetched latest code inside a virtualenv, which is an isolated, *virtual* python local environment that avoids messing with your global paths. You will notice you are *inside* a virtualenv because you will see a modified prompt reminding it to you (*leap-client-testbuild* in this case). +The above bootstrap script has fetched latest code inside a virtualenv, which is an isolated, *virtual* python local environment that avoids messing with your global paths. You will notice you are *inside* a virtualenv because you will see a modified prompt reminding it to you (*bitmask-testbuild* in this case). Thus, if you forget to *activate your virtualenv*, bitmask will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing:: diff --git a/docs/user/install.rst b/docs/user/install.rst index b5fb7810..81807a43 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -6,6 +6,8 @@ Installation This part of the documentation covers the installation of Bitmask. We assume that you want to get it properly installed before being able to use it. But we can we wrong. +.. _standalone-bundle: + Standalone bundle ----------------- diff --git a/pkg/scripts/bitmask_bootstrap.sh b/pkg/scripts/bitmask_bootstrap.sh new file mode 100644 index 00000000..42eb0af9 --- /dev/null +++ b/pkg/scripts/bitmask_bootstrap.sh @@ -0,0 +1,49 @@ +#!/bin/bash + +# Installs requirements, and +# clones the latest leap-client + +# depends on: +# openvpn git-core libgnutls-dev python-dev python-qt4 python-setuptools python-virtualenv + +# Escape code +esc=`echo -en "\033"` + +# Set colors +cc_green="${esc}[0;32m" +cc_yellow="${esc}[0;33m" +cc_blue="${esc}[0;34m" +cc_red="${esc}[0;31m" +cc_normal=`echo -en "${esc}[m\017"` + +echo "${cc_yellow}" +echo "~~~~~~~~~~~~~~~~~~~~~~~" +echo " Bitmask bootstrapping " +echo "~~~~~~~~~~~~~~~~~~~~~~~" +echo "" +echo "${cc_green}Creating virtualenv...${cc_normal}" + +mkdir bitmask-testbuild +virtualenv bitmask-testbuild +source bitmask-testbuild/bin/activate + +echo "${cc_green}Installing bitmask...${cc_normal}" + +# Clone latest git (develop branch) +# change "develop" for any other branch you want. + + +pip install -e 'git://leap.se/leap_client@develop#egg=leap.bitmask' + +cd bitmask-testbuild + +# symlink the pyside libraries to the system libs +./src/leap.bitmask/pkg/postmkvenv.sh + +echo "${cc_green}bitmask installed! =)" +echo "${cc_yellow}" +echo "Launch it with: " +echo "~~~~~~~~~~~~~~~~~~~~~~" +echo "bin/bitmask" +echo "~~~~~~~~~~~~~~~~~~~~~~" +echo "${cc_normal}" diff --git a/pkg/scripts/leap_client_bootstrap.sh b/pkg/scripts/leap_client_bootstrap.sh deleted file mode 100644 index dcde64f9..00000000 --- a/pkg/scripts/leap_client_bootstrap.sh +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/bash - -# Installs requirements, and -# clones the latest leap-client - -# depends on: -# openvpn git-core libgnutls-dev python-dev python-qt4 python-setuptools python-virtualenv - -# Escape code -esc=`echo -en "\033"` - -# Set colors -cc_green="${esc}[0;32m" -cc_yellow="${esc}[0;33m" -cc_blue="${esc}[0;34m" -cc_red="${esc}[0;31m" -cc_normal=`echo -en "${esc}[m\017"` - -echo "${cc_yellow}" -echo "~~~~~~~~~~~~~~~~~~~~~~" -echo "LEAP " -echo "client bootstrapping " -echo "~~~~~~~~~~~~~~~~~~~~~~" -echo "" -echo "${cc_green}Creating virtualenv...${cc_normal}" - -mkdir leap-client-testbuild -virtualenv leap-client-testbuild -source leap-client-testbuild/bin/activate - -echo "${cc_green}Installing leap client...${cc_normal}" - -# Clone latest git (develop branch) -# change "develop" for any other branch you want. - - -pip install -e 'git://leap.se/leap_client@develop#egg=leap-client' - -cd leap-client-testbuild - -# symlink the pyside libraries to the system libs -./src/leap-client/pkg/postmkvenv.sh - -echo "${cc_green}leap-client installed! =)" -echo "${cc_yellow}" -echo "Launch it with: " -echo "~~~~~~~~~~~~~~~~~~~~~~" -echo "bin/leap-client" -echo "~~~~~~~~~~~~~~~~~~~~~~" -echo "${cc_normal}" -- cgit v1.2.3 From 869989b3ce7e1aee3f70fbced91d3c76cd27045a Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Fri, 6 Sep 2013 18:24:49 +0200 Subject: add x bit --- pkg/scripts/bitmask_bootstrap.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 pkg/scripts/bitmask_bootstrap.sh diff --git a/pkg/scripts/bitmask_bootstrap.sh b/pkg/scripts/bitmask_bootstrap.sh old mode 100644 new mode 100755 -- cgit v1.2.3