diff options
Diffstat (limited to 'docs/other_eclipse.md')
-rw-r--r-- | docs/other_eclipse.md | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/docs/other_eclipse.md b/docs/other_eclipse.md index cb3ceb540..91557d07d 100644 --- a/docs/other_eclipse.md +++ b/docs/other_eclipse.md | |||
@@ -50,7 +50,7 @@ This is the most important plugin as it will allow Eclipse to _understand_ AVR C | |||
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) |
51 | This plugin is necessary to properly display the colored build output generated by the QMK makefile. | 51 | This plugin is necessary to properly display the colored build output generated by the QMK makefile. |
52 | 52 | ||
53 | 1. Open <kbd><kbd>Help</kbd> > <kbd>Eclipse Marketplace…</kbd></kbd> | 53 | 1. Open <kbd>Help</kbd> > <kbd>Eclipse Marketplace…</kbd> |
54 | 2. Search for _ANSI Escape in Console_ | 54 | 2. Search for _ANSI Escape in Console_ |
55 | 3. Click the <samp>Install</samp> button of the plugin | 55 | 3. Click the <samp>Install</samp> button of the plugin |
56 | 4. Follow the instructions and agree again with the security warning for unsigned content. | 56 | 4. Follow the instructions and agree again with the security warning for unsigned content. |
@@ -59,7 +59,7 @@ 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>File</kbd> > <kbd>New</kbd> > <kbd>Makefile Project with Existing Code</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_; |
65 | * (Optional) Give a different name to the project¹, e.g. _QMK_ or _Quantum_; | 65 | * (Optional) Give a different name to the project¹, e.g. _QMK_ or _Quantum_; |
@@ -73,16 +73,18 @@ Once both plugins are installed, restart Eclipse as prompted. | |||
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 | |
77 | 77 | We will now change the default make target of the the project from `all` to the | |
78 | 1. On the right side of the screen, select the <kbd>Make Target</kbd> tab | 78 | specific keyboard and keymap combination we are working on, |
79 | 2. Expand the folder structure to the keyboard of your choice, e.g. `qmk_firmware/keyboards/ergodox` | 79 | e.g. `kinesis/kint36:stapelberg`. This way, project-wide actions like cleaning |
80 | 3. Right-click on the keyboard folder and select <kbd>New…</kbd> (or select the folder and click the <kbd>New Make Target</kbd> icon above the tree) | 80 | and building the project will complete quickly, instead of taking a long time or |
81 | 4. Choose a name for your build target, e.g. _clean \<your keymap\>_ | 81 | outright locking up Eclipse. |
82 | 5. Make Target: this is the arguments that you give to `make` when building from the command line. If your target name does not match these arguments, uncheck <kbd>Same as target name</kbd> and input the correct arguments, e.g. `clean <your keymap>` | 82 | |
83 | 6. Leave the other options checked and click <kbd>OK</kbd>. Your make target will now appear under the selected keyboard. | 83 | 1. Focus an editor tab within the project |
84 | 7. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target. | 84 | 2. Open the `Project` > `Properties` window, then select the `C/C++ Build` list |
85 | 8. Double-click the build target you created to trigger a build. | 85 | entry and switch to the `Behavior` tab. |
86 | 9. Select the <kbd>Console</kbd> view at the bottom to view the running build. | 86 | 3. Change the default `Make build target` text fields for all enabled builds |
87 | from `all` to e.g. `kinesis/kint41:stapelberg`. | ||
88 | 4. Verify your setup works by selecting `Project` > `Clean...`. | ||
87 | 89 | ||
88 | [1]: https://en.wikipedia.org/wiki/Eclipse_(software) | 90 | [1]: https://en.wikipedia.org/wiki/Eclipse_(software) |