From 0b9b2d78c276c20a1cf9900b0ae359257ed5e183 Mon Sep 17 00:00:00 2001 From: unknown Date: Fri, 25 Sep 2015 11:23:21 +0200 Subject: [PATCH] Added note on how to run activate in Windows --- docs/contributing-core.rst | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/contributing-core.rst b/docs/contributing-core.rst index 0c8f823..7fc2da1 100644 --- a/docs/contributing-core.rst +++ b/docs/contributing-core.rst @@ -19,7 +19,9 @@ There are always at least two branches: The master branch only accepts atomic, small commits. Larger changes that might break the master branch should happen in the develop branch . The develop branch will be merged into the master after deep testing. If you want to refactor major parts of the code or try new ideas, create a dedicated branch. This will merged into develop once tested. The easiest way to start hacking Lantz codebase is using a virtual environment -and cloning an editable package. +and cloning an editable package. This allows to isolate your working environment +from your development environment and fastly switch between them, without the +risk of breaking anything. Assuming that you have installed all the requirements described in :ref:`tutorial-installing`, in OSX/Linux:: @@ -40,11 +42,24 @@ and in Windows:: and then install an editable package from `Lantz at Github`_:: - $ pip install -e git+git://github.com/hgrecco/lantz.git#egg=lantz + $ pip install -e git+git://github.com/LabPy/lantz.git#egg=lantz You will find the code in `~/lantzenv/src/lantz` (OSX/Linux) or `%USERPROFILE%\\Desktop\\lantzenv\\src\\lantz` (Windows). +.. note:: + If you are using the PowerShell on Windows, the ``activate`` script may not + be able to run. To solve this issue you have to change the execution + policies in your system, allowing scripts to run. For this you have to open + PowerShell with administrative rights (right click on the icon and select + ``Run as Administrator``). Then you can just type:: + PS C:\> Set-ExecutionPolicy AllSigned + + Go back to the PowerShell with normal user rights and try to run the + activate again. If it fails, you can relax the system policy even more:: + PS C:\> Set-ExecutionPolicy RemoteSigned + + File system structure --------------------- @@ -63,7 +78,7 @@ The distribution is organized in the following folders: **examples** - Root folder for the examples. + Root folder for the examples. **lantz** @@ -161,7 +176,7 @@ Finally, we have a small Zen import this Lantz should not get in your way. Unless you actually want it to. - Even then, python ways should not be void. + Even then, python ways should not be void. Provide solutions for common scenarios. Leave the special cases for the people who actually need them. Logging is great, do it often!