We recommend that you setup SSH access to Github.com 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 account.
Now run:
git clone [email protected]:RobotLocomotion/drake.git
Note: we suggest you keep the default clone directory name (drake) and not
rename it (such as drake2). The CLion integration will suffer if the
checkout directory is not named drake. (See :doc:`clion` for details.)
Note: the build process may encounter problems if you have unusual characters like parentheses in the absolute path to the drake directory (see #394).
The above git clone command will configure Drake's primary repository as a
remote called origin. We recommend that you configure your fork of Drake's
primary repository as the origin remote and Drake's primary repository as
the upstream remote. This can be done by executing the following commands:
cd drake git remote set-url origin [email protected]:[your github user name]/drake.git git remote add upstream [email protected]:RobotLocomotion/drake.git git remote set-url --push upstream no_push
Before running the build, you must follow some one-time platform-specific setup steps:
.. toctree::
:maxdepth: 1
mac
ubuntu
See :ref:`supported configurations <supported-configurations>` for the configurations and platforms that Drake officially supports. All else being equal, we would recommend developers use Ubuntu Xenial.
For instructions, jump to :ref:`Using Bazel <using_bazel>`, or check out the full details at:
.. toctree::
:maxdepth: 1
bazel