summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2013-09-05 12:50:06 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2013-09-05 15:21:18 -0300
commit29b06e7ecd26b9bf567ef9abd7425c342ec440be (patch)
treed578e3fc529d81d179f6a01d7d80eb1908f0f155
parent2bcff2cf5154af5bf129ced066a014925a5eac0b (diff)
Update docs for testers and bootstrap script.
-rw-r--r--docs/testers/howto.rst8
-rw-r--r--docs/user/install.rst2
-rw-r--r--pkg/scripts/bitmask_bootstrap.sh (renamed from pkg/scripts/leap_client_bootstrap.sh)25
3 files changed, 18 insertions, 17 deletions
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 <standalone-bundle>` 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/leap_client_bootstrap.sh b/pkg/scripts/bitmask_bootstrap.sh
index dcde64f9..42eb0af9 100644
--- a/pkg/scripts/leap_client_bootstrap.sh
+++ b/pkg/scripts/bitmask_bootstrap.sh
@@ -17,34 +17,33 @@ cc_red="${esc}[0;31m"
cc_normal=`echo -en "${esc}[m\017"`
echo "${cc_yellow}"
-echo "~~~~~~~~~~~~~~~~~~~~~~"
-echo "LEAP "
-echo "client bootstrapping "
-echo "~~~~~~~~~~~~~~~~~~~~~~"
+echo "~~~~~~~~~~~~~~~~~~~~~~~"
+echo " Bitmask bootstrapping "
+echo "~~~~~~~~~~~~~~~~~~~~~~~"
echo ""
echo "${cc_green}Creating virtualenv...${cc_normal}"
-mkdir leap-client-testbuild
-virtualenv leap-client-testbuild
-source leap-client-testbuild/bin/activate
+mkdir bitmask-testbuild
+virtualenv bitmask-testbuild
+source bitmask-testbuild/bin/activate
-echo "${cc_green}Installing leap client...${cc_normal}"
+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-client'
+pip install -e 'git://leap.se/leap_client@develop#egg=leap.bitmask'
-cd leap-client-testbuild
+cd bitmask-testbuild
# symlink the pyside libraries to the system libs
-./src/leap-client/pkg/postmkvenv.sh
+./src/leap.bitmask/pkg/postmkvenv.sh
-echo "${cc_green}leap-client installed! =)"
+echo "${cc_green}bitmask installed! =)"
echo "${cc_yellow}"
echo "Launch it with: "
echo "~~~~~~~~~~~~~~~~~~~~~~"
-echo "bin/leap-client"
+echo "bin/bitmask"
echo "~~~~~~~~~~~~~~~~~~~~~~"
echo "${cc_normal}"