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

Remove Windows documentation. #3685

Merged
merged 1 commit into from
Oct 5, 2016
Merged
Show file tree
Hide file tree
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: 1 addition & 22 deletions drake/doc/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ officially supports. Supported configurations are tested in continuous
integration. All other configurations are provided on a best-effort basis.

On Ubuntu and OS X, the "Unix Makefiles" and "Ninja" CMake generators are
supported. On Windows, the "Visual Studio 14 2015",
"Visual Studio 14 2015 Win64", and "Ninja" CMake generators are supported.
supported.

The supported version of MATLAB is R2015b.

Expand All @@ -98,26 +97,6 @@ and ``WITH_GFLAGS``, which should be set to ``ON``.
| | | Java 1.7 | +---------+
| | | | Release |
+-----------------------------------------+--------------------+-------------------+---------+
| | Windows Server 2012 R2 or Windows 8.1 | | MSVC 14 32-bit | Minimal | Debug |
| | Visual Studio 2015 (any edition) | | Java 1.7 | +---------+
| | | | Release |
| | +-------------------+---------+
| | | Default | Debug |
| | | +---------+
| | | | Release |
| | +-------------------+---------+
| | | Default + MATLAB | Release |
| +--------------------+-------------------+---------+
| | | MSVC 14 64-bit | Minimal | Debug |
| | | Java 1.7 | +---------+
| | | | Release |
| | +-------------------+---------+
| | | Default | Debug |
| | | +---------+
| | | | Release |
| | +-------------------+---------+
| | | Default + MATLAB | Release |
+-----------------------------------------+--------------------+-------------------+---------+
| OS X 10.10 | | Apple Clang 7.0 | Minimal | Debug |
| | | Java 1.8 | +---------+
| | | | Release |
Expand Down
2 changes: 1 addition & 1 deletion drake/doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ they will get in sync soon, but for now I've decided the best fix is to edit the
Drake tells me I don't have Simulink 3D Animation Toolbox, but I'm sure that I do!
==================================================================================

You might have to actually tell MATLAB to install the tool, running ``vrinstall`` in MATLAB. On windows, use ``vrinstall -install editor``.
You might have to actually tell MATLAB to install the tool, running ``vrinstall`` in MATLAB.

.. _faq_undefined_symbol-sincos_stret:

Expand Down
15 changes: 3 additions & 12 deletions drake/doc/from_binary.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************************************
Binary installation (mac, linux, windows)
*****************************************
********************************
Binary installation (mac, linux)
********************************

Note: This is still new and relatively untested. Please report any issues you have.

Expand All @@ -25,15 +25,6 @@ Then ``cd`` into the examples directories and try some things out. Here are a f

Please note that you will have to run `addpath_drake` each time you start MATLAB, or `add it to your startup.m <http://www.mathworks.com/help/matlab/ref/startup.html>`_.


Windows Specific
----------------

In certain cases, Microsoft's redistributable C++ runtime libraries need to be installed for mex files to work correctly in Windows. They can be found here: http://www.microsoft.com/en-us/download/details.aspx?id=40784

In order to use the Drake visualizer in Windows, the `drake_visualizer.bat` file must be executed from the `build/` folder within Drake.


Linux Specific
--------------

Expand Down
17 changes: 8 additions & 9 deletions drake/doc/from_source.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
.. _build_from_source:

*****************************************
Source installation (mac, linux, windows)
*****************************************
********************************
Source installation (mac, linux)
********************************

Optional: Setting up the MATLAB Compiler
========================================

If you'd like to build the MATLAB interface, you will need a `C/C++ compiler that is compatible with your MATLAB version <http://www.mathworks.com/support/compilers/>`_. Run ``mex -setup`` at the MATLAB command line to set this up. We typically use gcc on linux, clang on mac, or Visual Studio 2015 on Windows.

Make sure that the MATLAB executable is in your path. (e.g., typing ``matlab`` at the system command line should start an instance of MATLAB). For example, on Mac you might consider ``sudo ln -s /Applications/MATLAB_R2014a.app/bin/matlab /usr/bin/matlab``, or you can actually add the MATLAB/bin directory to your system path. On windows, you should `edit your path environment variable <http://www.java.com/en/download/help/path.xml>`_ to include e.g. ``C:\Program Files\MATLAB\R2014a\bin``.
Make sure that the MATLAB executable is in your path. (e.g., typing ``matlab``
at the system command line should start an instance of MATLAB). For example,
on Mac you might consider
``sudo ln -s /Applications/MATLAB_R2014a.app/bin/matlab /usr/bin/matlab``,
or you can actually add the MATLAB/bin directory to your system path.

.. _getting_drake:

Getting Drake
=============

Note: If you are using Windows, you will want to make sure that ``git`` is set to `handle cross-platform linefeed issues <https://git-scm.com/book/tr/v2/Customizing-Git-Git-Configuration#idp31554304>`_. These options appear to be enabled by default in the cygwin installation of ``git``, but must be set manually on the native windows version.

We recommend that you `setup SSH access to github.com <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_
to avoid needing to type your password each time you access it. The following
instructions assume you have uploaded your public SSH key to your Github
Expand Down Expand Up @@ -87,7 +87,6 @@ setup steps:
homebrew
ubuntu_trusty
ubuntu_xenial
windows

.. _build_the_collection:

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6 changes: 3 additions & 3 deletions drake/doc/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ useful:

Configuration
=============
An issue may have configuration ``linux``, ``windows``, and/or ``mac``. It may
additionally have configuration ``matlab``. If no ``configuration`` label is
present, the issue is assumed to affect all configurations.
An issue may have configuration ``linux`` or ``mac``. It may additionally have
configuration ``matlab``. If no ``configuration`` label is present, the issue
is assumed to affect all configurations.

Status
======
Expand Down
2 changes: 1 addition & 1 deletion drake/doc/jenkins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Running an On-Demand Build

There are a number of Jenkins builds that do not normally run pre-merge, but
do run post-merge or nightly. The post-merge and nightly builds include
long-running tests, lower-priority platforms (e.g. Windows MATLAB), and
long-running tests, lower-priority platforms (e.g. Mac), and
specialized options (e.g.
`MemorySanitizer <https://github.com/google/sanitizers/wiki/MemorySanitizer>`_).
Members of the RobotLocomotion organization can manually schedule these builds
Expand Down
2 changes: 1 addition & 1 deletion drake/doc/sublime_text.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To change your custom user preferences, go to "Sublime Text", "Preferences",
Full File Path Display
----------------------
Note that this only needs to be done on OS X since the full path appears by
default on Windows and Linux machines.
default on Linux machines.

To display the current file's full path in the title bar on OSX::

Expand Down
207 changes: 0 additions & 207 deletions drake/doc/windows.rst

This file was deleted.