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 Windows installation section #30

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/source/setup.rst
Expand Up @@ -67,6 +67,50 @@ Nothing is installed globally, so to start from scratch you can just follow thes
cd pcbmode
git clean -dfX # erases any untracked files (build files etc). save your work!


Installation on Windows
========================================

Only Linux is officially supported, so consider this experimental,
and prone to breaking at any time.

Start with the dependencies:

Make sure you have Python 2.7.9 or later, this is the first Windows
version with pip bundled. It's also assumed that Python has been
added to the system path.

Install Lxml:
Download an appropriate binary `here <http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_.

Confusingly enough, the default Python install is a 32-bit version,
even when installed on a 64-bit version, so you probably want
*lxml-3.6.4-cp27-cp27m-win32.whl*

Then upgrade pip and install the Lxml wheel:

.. code-block:: bash

cd path\to\downloads
python -m pip install --upgrade pip
python -m pip install lxml-3.6.4-cp27-cp27m-win32.whl


Fetch the *PCBModE* source. Stable snapshots are available at
`https://github.com/boldport/pcbmode/releases
<https://github.com/boldport/pcbmode/releases>`_. The latest
development sources are available via git:

.. code-block:: bash

git clone https://github.com/boldport/pcbmode.git
cd pcbmode
python setup.py install


There will now be a ``pcbmode.exe`` in your ``C:\Python27\Scripts`` directory.
Add this to the system path, or use the whole path whenever you call PCBmodE.

Running PCBmodE
===============

Expand Down