diff options
Diffstat (limited to 'docs/eclipse.md')
| -rw-r--r-- | docs/eclipse.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/eclipse.md b/docs/eclipse.md index a63b84607..c51df522d 100644 --- a/docs/eclipse.md +++ b/docs/eclipse.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | # Setting Up Eclipse for QMK Development | 1 | # Setting up Eclipse for QMK Development |
| 2 | 2 | ||
| 3 | [Eclipse](https://en.wikipedia.org/wiki/Eclipse_(software)) is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages. | 3 | [Eclipse](https://en.wikipedia.org/wiki/Eclipse_(software)) is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages. |
| 4 | 4 | ||
| @@ -16,16 +16,16 @@ The purpose of the is page is to document how to set-up Eclipse for developing A | |||
| 16 | Note that this set-up has been tested on Ubuntu 16.04 only for the moment. | 16 | Note that this set-up has been tested on Ubuntu 16.04 only for the moment. |
| 17 | 17 | ||
| 18 | # Prerequisites | 18 | # Prerequisites |
| 19 | ## Build environment | 19 | ## Build Environment |
| 20 | Before starting, you must have followed the [Getting Started](home.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command). | 20 | Before starting, you must have followed the [Getting Started](home.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command). |
| 21 | 21 | ||
| 22 | ## Java | 22 | ## Java |
| 23 | Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development. | 23 | Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development. |
| 24 | 24 | ||
| 25 | # Install Eclipse and its plugins | 25 | # Install Eclipse and Its Plugins |
| 26 | Eclipse comes in [several flavours](http://www.eclipse.org/downloads/eclipse-packages/) depending on the target usage that you will have. There is no package comprising the AVR stack, so we will need to start from Eclipse CDT (C/C++ Development Tooling) and install the necessary plugins. | 26 | Eclipse comes in [several flavours](http://www.eclipse.org/downloads/eclipse-packages/) depending on the target usage that you will have. There is no package comprising the AVR stack, so we will need to start from Eclipse CDT (C/C++ Development Tooling) and install the necessary plugins. |
| 27 | 27 | ||
| 28 | ## Download and install Eclipse CDT | 28 | ## Download and Install Eclipse CDT |
| 29 | If you already have Eclipse CDT on your system, you can skip this step. However it is advised to keep it up-to-date for better support. | 29 | If you already have Eclipse CDT on your system, you can skip this step. However it is advised to keep it up-to-date for better support. |
| 30 | 30 | ||
| 31 | If you have another Eclipse package installed, it is normally possible to [install the CDT plugin over it](https://eclipse.org/cdt/downloads.php). However it is probably better to reinstall it from scratch to keep it light and avoid the clutter of tools that you don't need for the projects you will be working on. | 31 | If you have another Eclipse package installed, it is normally possible to [install the CDT plugin over it](https://eclipse.org/cdt/downloads.php). However it is probably better to reinstall it from scratch to keep it light and avoid the clutter of tools that you don't need for the projects you will be working on. |
| @@ -41,10 +41,10 @@ When you are prompted with the Workspace Selector, select a directory that will | |||
| 41 | 41 | ||
| 42 | Once started, click the <kbd>Workbench</kbd> button at the top right to switch to the workbench view (there is a also checkbox at the bottom to skip the welcome screen at startup). | 42 | Once started, click the <kbd>Workbench</kbd> button at the top right to switch to the workbench view (there is a also checkbox at the bottom to skip the welcome screen at startup). |
| 43 | 43 | ||
| 44 | ## Install the necessary plugins | 44 | ## Install the Necessary Plugins |
| 45 | Note: you do not need to restart Eclipse after installing each plugin. Simply restart once all plugins are installed. | 45 | Note: you do not need to restart Eclipse after installing each plugin. Simply restart once all plugins are installed. |
| 46 | 46 | ||
| 47 | ### [The AVR plugin](http://avr-eclipse.sourceforge.net/) | 47 | ### [The AVR Plugin](http://avr-eclipse.sourceforge.net/) |
| 48 | This is the most important plugin as it will allow Eclipse to _understand_ AVR C code. Follow [the instructions for using the update site](http://avr-eclipse.sourceforge.net/wiki/index.php/Plugin_Download#Update_Site), and agree with the security warning for unsigned content. | 48 | This is the most important plugin as it will allow Eclipse to _understand_ AVR C code. Follow [the instructions for using the update site](http://avr-eclipse.sourceforge.net/wiki/index.php/Plugin_Download#Update_Site), and agree with the security warning for unsigned content. |
| 49 | 49 | ||
| 50 | ### [ANSI Escape in Console](https://marketplace.eclipse.org/content/ansi-escape-console) | 50 | ### [ANSI Escape in Console](https://marketplace.eclipse.org/content/ansi-escape-console) |
| @@ -58,7 +58,7 @@ This plugin is necessary to properly display the colored build output generated | |||
| 58 | Once both plugins are installed, restart Eclipse as prompted. | 58 | Once both plugins are installed, restart Eclipse as prompted. |
| 59 | 59 | ||
| 60 | # Configure Eclipse for QMK | 60 | # Configure Eclipse for QMK |
| 61 | ## Importing the project | 61 | ## Importing the Project |
| 62 | 1. Click <kbd><kbd>File</kbd> > <kbd>New</kbd> > <kbd>Makefile Project with Existing Code</kbd></kbd> | 62 | 1. Click <kbd><kbd>File</kbd> > <kbd>New</kbd> > <kbd>Makefile Project with Existing Code</kbd></kbd> |
| 63 | 2. On the next screen: | 63 | 2. On the next screen: |
| 64 | * Select the directory where you cloned the repository as _Existing Code Location_; | 64 | * Select the directory where you cloned the repository as _Existing Code Location_; |
| @@ -72,7 +72,7 @@ Once both plugins are installed, restart Eclipse as prompted. | |||
| 72 | 72 | ||
| 73 | ¹ There might be issues for importing the project with a custom name. If it does not work properly, try leaving the default project name (i.e. the name of the directory, probably `qmk_firmware`). | 73 | ¹ There might be issues for importing the project with a custom name. If it does not work properly, try leaving the default project name (i.e. the name of the directory, probably `qmk_firmware`). |
| 74 | 74 | ||
| 75 | ## Build your keyboard | 75 | ## Build Your Keyboard |
| 76 | We will now configure a make target that cleans the project and builds the keymap of your choice. | 76 | We will now configure a make target that cleans the project and builds the keymap of your choice. |
| 77 | 77 | ||
| 78 | 1. On the right side of the screen, select the <kbd>Make Target</kbd> tab | 78 | 1. On the right side of the screen, select the <kbd>Make Target</kbd> tab |