<commit_before>============
Installation
============

If you've downloaded a pre-built binary for a specific vehicle, see the
:doc:`binary` section for instructions on how to flash your CAN
translator. Most users do not need to set up the full development described in
these docs.

Quick Start
============

Linux
-----

1. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
2. Install Git from your distribution's package manager and clone the
   `cantranslator <https://github.com/openxc/cantranslator>`_ repository: ``git
   clone https://github.com/openxc/cantranslator``
3. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
4. If there were no errors, you are ready to
   :doc:`compile <compiling>`.

The ``bootstrap.sh`` script is tested in Ubuntu 12.04 and Arch Linux - other
distributions will need to install the dependencies manually.

Windows
-------

1. Install `Cygwin <http://www.cygwin.com>`_ and in the installer, select the
   following packagse: ``gcc4, patchutils, git, unzip, python, python-argparse,
   check, curl, libsasl2, ca-certificates``
2. Start a Cygwin Terminal.
3. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
4. Clone the `cantranslator <https://github.com/openxc/cantranslator>`_
   repository: ``git clone https://github.com/openxc/cantranslator``
5. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
6. If there were no errors, you are ready to
   :doc:`compile <compiling>`.

OS X
--------

1. Open the Terminal app.
2. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
3. Install `Homebrew <http://mxcl.github.com/homebrew/>`_:
   ``ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"``
4. Install Git with Homebrew (``brew install git``) and clone the `cantranslator
   <https://github.com/openxc/cantranslator>`_ repository: ``git clone
   https://github.com/openxc/cantranslator``
5. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
6. If there were no errors, you are ready to
   :doc:`compile <compiling>`.

Dependencies
============

In order to build the CAN translator firmware from source, you need a few
dependencies:

* Git
* ``cantranslator`` :ref:`source code <source>` cloned with Git - not from a .zip file
* :ref:`MPIDE <mpidedep>`
* Digilent's USB and CAN :ref:`libraries for the chipKIT <chipkit-libs>`
* :ref:`FTDI driver <ftdi>`
* Mini-USB cable

If instead of the chipKIT, you are compiling for the Blueboard (based on the
NXP LPC1768/69), instead of MPIDE you will need:

* :ref:`GCC for ARM <gcc-arm>` toolchain
* :ref:`OpenOCD <openocddep>`
* JTAG programmer compatible with ``openocd`` - we've tested the Olimex
  ARM-OCD-USB programmer.

The easiest way to install these dependencies is to use the<commit_msg>Note that if bootstrap fails, you're on your own.<commit_after>============
Installation
============

If you've downloaded a pre-built binary for a specific vehicle, see the
:doc:`binary` section for instructions on how to flash your CAN
translator. Most users do not need to set up the full development described in
these docs.

Quick Start
============

Linux
-----

1. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
2. Install Git from your distribution's package manager and clone the
   `cantranslator <https://github.com/openxc/cantranslator>`_ repository: ``git
   clone https://github.com/openxc/cantranslator``
3. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
4. If there were no errors, you are ready to
   :doc:`compile <compiling>`. If there are errors, follow the recommendations
   in the error messages. You may need to manually install the dependencies if
   your environment is not in a predictable state.

The ``bootstrap.sh`` script is tested in Ubuntu 12.04 and Arch Linux - other
distributions will need to install the dependencies manually.

Windows
-------

1. Install `Cygwin <http://www.cygwin.com>`_ and in the installer, select the
   following packages ``gcc4, patchutils, git, unzip, python, python-argparse,
   check, curl, libsasl2, ca-certificates``
2. Start a Cygwin Terminal.
3. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
4. Clone the `cantranslator <https://github.com/openxc/cantranslator>`_
   repository: ``git clone https://github.com/openxc/cantranslator``
5. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
6. If there were no errors, you are ready to
   :doc:`compile <compiling>`. If there are errors, follow the recommendations
   in the error messages. You may need to manually install the dependencies if
   your environment is not in a predictable state.

OS X
--------

1. Open the Terminal app.
2. If your network uses an Internet proxy (e.g. a corporate network) set the
   ``http_proxy`` environment variable: ``export http_proxy=<your proxy>``
3. Install `Homebrew <http://mxcl.github.com/homebrew/>`_:
   ``ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"``
4. Install Git with Homebrew (``brew install git``) and clone the `cantranslator
   <https://github.com/openxc/cantranslator>`_ repository: ``git clone
   https://github.com/openxc/cantranslator``
5. Run ``script/bootstrap.sh`` from the ``cantranslator`` directory.
6. If there were no errors, you are ready to
   :doc:`compile <compiling>`. If there are errors, follow the recommendations
   in the error messages. You may need to manually install the dependencies if
   your environment is not in a predictable state.

Dependencies
============

In order to build the CAN translator firmware from source, you need a few
dependencies:

* Git
* ``cantranslator`` :ref:`source code <source>` cloned with Git - not from a .zip file
* :ref:`MPIDE <mpidedep>`
* Digilent's USB and CAN :ref:`libraries for the chipKIT <chipkit-libs>`
* :ref:`FTDI driver <ftdi>`
* Mini-USB cable

If instead of the chipKIT, you are compiling for the Blueboard (based on the
NXP LPC1768/69), instead of MPIDE you will need:

* :ref:`GCC for ARM <gcc-arm>` toolchain
* :ref:`OpenOCD <openocddep>`
* JTAG programmer compatible with ``openocd`` - we've tested the Olimex
  ARM-OCD-USB programmer.

The easiest way to install these dependencies is to use the
{'fraction_non_alphanumeric': 0.12452830188679245, 'fraction_numerical': 0.008452830188679246, 'mean_word_length': 4.343548387096774, 'pattern_counts': {'":': 0, '<': 37, '<?xml version=': 0, '>': 37, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2536041', 'n_tokens_mistral': 2014, 'n_tokens_neox': 1962, 'n_words': 817}