Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added note on how to run activate in Windows #60

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions docs/contributing-core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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
---------------------
Expand All @@ -63,7 +78,7 @@ The distribution is organized in the following folders:

**examples**

Root folder for the examples.
Root folder for the examples.

**lantz**

Expand Down Expand Up @@ -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!
Expand Down