├── .vscode ├── extensions.json ├── settings.json ├── launch.json └── tasks.json ├── README.md ├── zephyr-linux.code-workspace ├── zephyr-macos.code-workspace ├── zephyr-windows.code-workspace └── LICENSE /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "ms-vscode.cpptools-extension-pack", 4 | "ms-python.python", 5 | "ms-vscode.vscode-embedded-tools", 6 | "ms-vscode.vscode-serial-monitor", 7 | "marus25.cortex-debug", 8 | "donjayamanne.python-environment-manager" 9 | ] 10 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | // Hush CMake 3 | "cmake.configureOnOpen": false, 4 | 5 | // IntelliSense 6 | "C_Cpp.default.compilerPath": "${userHome}/zephyr-sdk-0.16.1/arm-zephyr-eabi/bin/arm-zephyr-eabi-gcc.exe", 7 | "C_Cpp.default.compileCommands": "${workspaceFolder}/build/compile_commands.json", 8 | 9 | // File Associations 10 | "files.associations": { 11 | } 12 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Launch", 6 | "device": "nRF52840_xxAA", 7 | "cwd": "${workspaceFolder}", 8 | "executable": "build/zephyr/zephyr.elf", 9 | "request": "launch", 10 | "type": "cortex-debug", 11 | "runToEntryPoint": "main", 12 | "servertype": "jlink", 13 | "gdbPath": "${userHome}/zephyr-sdk-0.16.1/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb", 14 | "preLaunchTask": "West Build" 15 | }, 16 | { 17 | "name": "Attach", 18 | "device": "nRF52840_xxAA", 19 | "cwd": "${workspaceFolder}", 20 | "executable": "build/zephyr/zephyr.elf", 21 | "request": "attach", 22 | "type": "cortex-debug", 23 | "runToEntryPoint": "main", 24 | "servertype": "jlink", 25 | "gdbPath": "${userHome}/zephyr-sdk-0.16.1/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb" 26 | }, 27 | ] 28 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # zephyr-vscode-example 2 | 3 | This is an example configuration for setting up Visual Studio Code for Zephyr application development. It was originally created for the talk entitled, "[Zephyr & Visual Studio Code: How to Develop Zephyr Apps with a Modern, Visual IDE](https://youtu.be/IKNHPmG-Qxo)" at EOSS 2023. 4 | 5 | ## Example details 6 | 7 | There are many, many different ways to develop a Zephyr application. This example currently assumes: 8 | 9 | * All paths follow the Getting Started Guide 10 | * Uses the Zephyr SDK where possible (ex. Host tools are not available on macOS or Windows) 11 | * In-tree development 12 | * Use of Python Virtual Environments 13 | * Building `samples/basic/thread` so we can demonstrate thread-aware debugging 14 | * Targetting an nRF52840 DK 15 | 16 | ## Steps 17 | 18 | 1. Follow the Zephyr [Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html) for your OS and make sure to use virtual environments 19 | 2. Turn on Compilation Database with `west config build.cmake-args -- -DCMAKE_EXPORT_COMPILE_COMMANDS=ON` 20 | 3. Copy the `.code-workspace` for your OS to `samples/basic/thread` as well the `.vscode` folder 21 | 4. Retrieve `ZEPHYR_SDK_INSTALL_DIR` with `cmake -P zephyr/cmake/verify-toolchain.cmake`. It'll be the prefix of the `C_Cpp.default.compilerPath` 22 | 5. Set the `Python: Interpreter Path` 23 | 6. CD to `samples/basic/thread` 24 | 7. Try the different build tasks and the flash task 25 | 8. Try to connect over the serial terminal 26 | 9. TODO try step debugging 27 | 28 | ## Credits 29 | 30 | https://zmk.dev/docs/development/ide-integration 31 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "West Build", 6 | "type": "shell", 7 | "group": { 8 | "kind": "build", 9 | "isDefault": true 10 | }, 11 | "linux": { 12 | "command": "${userHome}/zephyrproject/.venv/bin/west" 13 | }, 14 | "windows": { 15 | "command": "${userHome}/zephyrproject/.venv/Scripts/west.exe" 16 | }, 17 | "osx": { 18 | "command": "${userHome}/zephyrproject/.venv/bin/west" 19 | }, 20 | "args": [ 21 | "build", 22 | "-p", 23 | "auto", 24 | "-b", 25 | "nrf52840dk_nrf52840" 26 | ], 27 | "problemMatcher": [ 28 | "$gcc" 29 | ] 30 | }, 31 | { 32 | "label": "West Configurable Build", 33 | "type": "shell", 34 | "group": { 35 | "kind": "build", 36 | }, 37 | "linux": { 38 | "command": "${userHome}/zephyrproject/.venv/bin/west" 39 | }, 40 | "windows": { 41 | "command": "${userHome}/zephyrproject/.venv/Scripts/west.exe" 42 | }, 43 | "osx": { 44 | "command": "${userHome}/zephyrproject/.venv/bin/west" 45 | }, 46 | "args": [ 47 | "build", 48 | "-p", 49 | "${input:pristine}", 50 | "-b", 51 | "${input:board}" 52 | ], 53 | "problemMatcher": [ 54 | "$gcc" 55 | ] 56 | }, 57 | { 58 | "label": "West Flash", 59 | "type": "shell", 60 | "linux": { 61 | "command": "${userHome}/zephyrproject/.venv/bin/west" 62 | }, 63 | "windows": { 64 | "command": "${userHome}/zephyrproject/.venv/Scripts/west.exe" 65 | }, 66 | "osx": { 67 | "command": "${userHome}/zephyrproject/.venv/bin/west" 68 | }, 69 | "args": [ 70 | "flash" 71 | ], 72 | "problemMatcher": [ 73 | "$gcc" 74 | ] 75 | } 76 | ], 77 | "inputs": [ 78 | { 79 | "id": "board", 80 | "type": "promptString", 81 | "default": "nrf52840dk_nrf52840", 82 | "description": "See https://docs.zephyrproject.org/latest/boards/index.html" 83 | }, 84 | { 85 | "id": "pristine", 86 | "type": "pickString", 87 | "description": "Choose when to run a pristine build", 88 | "default": "auto", 89 | "options": [ 90 | "auto", 91 | "always", 92 | "never" 93 | ] 94 | } 95 | ] 96 | } -------------------------------------------------------------------------------- /zephyr-linux.code-workspace: -------------------------------------------------------------------------------- 1 | { 2 | "folders": [ 3 | { 4 | "path": "." 5 | } 6 | ], 7 | "settings": { 8 | // Hush CMake 9 | "cmake.configureOnOpen": false, 10 | 11 | // IntelliSense 12 | "C_Cpp.default.compilerPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gcc", 13 | "C_Cpp.default.compileCommands": "${workspaceFolder}/build/compile_commands.json", 14 | 15 | // File Associations 16 | "files.associations": {} 17 | }, 18 | "tasks": { 19 | "version": "2.0.0", 20 | "tasks": [ 21 | { 22 | "label": "West Build", 23 | "type": "shell", 24 | "group": { 25 | "kind": "build", 26 | "isDefault": true 27 | }, 28 | "command": "${userHome}/zephyrproject/.venv/bin/west", 29 | "args": [ 30 | "build", 31 | "-p", 32 | "auto", 33 | "-b", 34 | "nrf52840dk_nrf52840" 35 | ], 36 | "problemMatcher": [ 37 | "$gcc" 38 | ], 39 | }, 40 | { 41 | "label": "West Configurable Build", 42 | "type": "shell", 43 | "group": { 44 | "kind": "build", 45 | }, 46 | "command": "${userHome}/zephyrproject/.venv/bin/west", 47 | "args": [ 48 | "build", 49 | "-p", 50 | "${input:pristine}", 51 | "-b", 52 | "${input:board}" 53 | ], 54 | "problemMatcher": [ 55 | "$gcc" 56 | ] 57 | }, 58 | { 59 | "label": "West Flash", 60 | "type": "shell", 61 | "command": "${userHome}/zephyrproject/.venv/bin/west", 62 | "args": [ 63 | "flash" 64 | ], 65 | "problemMatcher": [ 66 | "$gcc" 67 | ] 68 | } 69 | ], 70 | "inputs": [ 71 | { 72 | "id": "board", 73 | "type": "promptString", 74 | "default": "nrf52840dk_nrf52840", 75 | "description": "See https://docs.zephyrproject.org/latest/boards/index.html" 76 | }, 77 | { 78 | "id": "pristine", 79 | "type": "pickString", 80 | "description": "Choose when to run a pristine build", 81 | "default": "auto", 82 | "options": [ 83 | "auto", 84 | "always", 85 | "never" 86 | ] 87 | } 88 | ] 89 | }, 90 | "launch": { 91 | "version": "0.2.0", 92 | "configurations": [ 93 | { 94 | "name": "Launch", 95 | "device": "nRF52840_xxAA", 96 | "cwd": "${workspaceFolder}", 97 | "executable": "build/zephyr/zephyr.elf", 98 | "request": "launch", 99 | "type": "cortex-debug", 100 | "runToEntryPoint": "main", 101 | "servertype": "jlink", 102 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb", 103 | "preLaunchTask": "West Build" 104 | }, 105 | { 106 | "name": "Attach", 107 | "device": "nRF52840_xxAA", 108 | "cwd": "${workspaceFolder}", 109 | "executable": "build/zephyr/zephyr.elf", 110 | "request": "attach", 111 | "type": "cortex-debug", 112 | "runToEntryPoint": "main", 113 | "servertype": "jlink", 114 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb" 115 | }, 116 | ] 117 | }, 118 | "extensions": { 119 | "recommendations": [ 120 | "ms-vscode.cpptools-extension-pack", 121 | "ms-python.python", 122 | "ms-vscode.vscode-embedded-tools", 123 | "ms-vscode.vscode-serial-monitor", 124 | "marus25.cortex-debug", 125 | "donjayamanne.python-environment-manager" 126 | ] 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /zephyr-macos.code-workspace: -------------------------------------------------------------------------------- 1 | { 2 | "folders": [ 3 | { 4 | "path": "." 5 | } 6 | ], 7 | "settings": { 8 | // Hush CMake 9 | "cmake.configureOnOpen": false, 10 | 11 | // IntelliSense 12 | "C_Cpp.default.compilerPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gcc", 13 | "C_Cpp.default.compileCommands": "${workspaceFolder}/build/compile_commands.json", 14 | 15 | // File Associations 16 | "files.associations": {} 17 | }, 18 | "tasks": { 19 | "version": "2.0.0", 20 | "tasks": [ 21 | { 22 | "label": "West Build", 23 | "type": "shell", 24 | "group": { 25 | "kind": "build", 26 | "isDefault": true 27 | }, 28 | "command": "${userHome}/zephyrproject/.venv/bin/west", 29 | "args": [ 30 | "build", 31 | "-p", 32 | "auto", 33 | "-b", 34 | "nrf52840dk_nrf52840" 35 | ], 36 | "problemMatcher": [ 37 | "$gcc" 38 | ], 39 | }, 40 | { 41 | "label": "West Configurable Build", 42 | "type": "shell", 43 | "group": { 44 | "kind": "build", 45 | }, 46 | "command": "${userHome}/zephyrproject/.venv/bin/west", 47 | "args": [ 48 | "build", 49 | "-p", 50 | "${input:pristine}", 51 | "-b", 52 | "${input:board}" 53 | ], 54 | "problemMatcher": [ 55 | "$gcc" 56 | ] 57 | }, 58 | { 59 | "label": "West Flash", 60 | "type": "shell", 61 | "command": "${userHome}/zephyrproject/.venv/bin/west", 62 | "args": [ 63 | "flash" 64 | ], 65 | "problemMatcher": [ 66 | "$gcc" 67 | ] 68 | } 69 | ], 70 | "inputs": [ 71 | { 72 | "id": "board", 73 | "type": "promptString", 74 | "default": "nrf52840dk_nrf52840", 75 | "description": "See https://docs.zephyrproject.org/latest/boards/index.html" 76 | }, 77 | { 78 | "id": "pristine", 79 | "type": "pickString", 80 | "description": "Choose when to run a pristine build", 81 | "default": "auto", 82 | "options": [ 83 | "auto", 84 | "always", 85 | "never" 86 | ] 87 | } 88 | ] 89 | }, 90 | "launch": { 91 | "version": "0.2.0", 92 | "configurations": [ 93 | { 94 | "name": "Launch", 95 | "device": "nRF52840_xxAA", 96 | "cwd": "${workspaceFolder}", 97 | "executable": "build/zephyr/zephyr.elf", 98 | "request": "launch", 99 | "type": "cortex-debug", 100 | "runToEntryPoint": "main", 101 | "servertype": "jlink", 102 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb", 103 | "preLaunchTask": "West Build" 104 | }, 105 | { 106 | "name": "Attach", 107 | "device": "nRF52840_xxAA", 108 | "cwd": "${workspaceFolder}", 109 | "executable": "build/zephyr/zephyr.elf", 110 | "request": "attach", 111 | "type": "cortex-debug", 112 | "runToEntryPoint": "main", 113 | "servertype": "jlink", 114 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb" 115 | }, 116 | ] 117 | }, 118 | "extensions": { 119 | "recommendations": [ 120 | "ms-vscode.cpptools-extension-pack", 121 | "ms-python.python", 122 | "ms-vscode.vscode-embedded-tools", 123 | "ms-vscode.vscode-serial-monitor", 124 | "marus25.cortex-debug", 125 | "donjayamanne.python-environment-manager" 126 | ] 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /zephyr-windows.code-workspace: -------------------------------------------------------------------------------- 1 | { 2 | "folders": [ 3 | { 4 | "path": "." 5 | } 6 | ], 7 | "settings": { 8 | // Hush CMake 9 | "cmake.configureOnOpen": false, 10 | 11 | // IntelliSense 12 | "C_Cpp.default.compilerPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gcc", 13 | "C_Cpp.default.compileCommands": "${workspaceFolder}/build/compile_commands.json", 14 | 15 | // File Associations 16 | "files.associations": {} 17 | }, 18 | "tasks": { 19 | "version": "2.0.0", 20 | "tasks": [ 21 | { 22 | "label": "West Build", 23 | "type": "shell", 24 | "group": { 25 | "kind": "build", 26 | "isDefault": true 27 | }, 28 | "command": "${userHome}/zephyrproject/.venv/Scripts/west", 29 | "args": [ 30 | "build", 31 | "-p", 32 | "auto", 33 | "-b", 34 | "nrf52840dk_nrf52840" 35 | ], 36 | "problemMatcher": [ 37 | "$gcc" 38 | ], 39 | }, 40 | { 41 | "label": "West Configurable Build", 42 | "type": "shell", 43 | "group": { 44 | "kind": "build", 45 | }, 46 | "command": "${userHome}/zephyrproject/.venv/Scripts/west", 47 | "args": [ 48 | "build", 49 | "-p", 50 | "${input:pristine}", 51 | "-b", 52 | "${input:board}" 53 | ], 54 | "problemMatcher": [ 55 | "$gcc" 56 | ] 57 | }, 58 | { 59 | "label": "West Flash", 60 | "type": "shell", 61 | "command": "${userHome}/zephyrproject/.venv/Scripts/west", 62 | "args": [ 63 | "flash" 64 | ], 65 | "problemMatcher": [ 66 | "$gcc" 67 | ] 68 | } 69 | ], 70 | "inputs": [ 71 | { 72 | "id": "board", 73 | "type": "promptString", 74 | "default": "nrf52840dk_nrf52840", 75 | "description": "See https://docs.zephyrproject.org/latest/boards/index.html" 76 | }, 77 | { 78 | "id": "pristine", 79 | "type": "pickString", 80 | "description": "Choose when to run a pristine build", 81 | "default": "auto", 82 | "options": [ 83 | "auto", 84 | "always", 85 | "never" 86 | ] 87 | } 88 | ] 89 | }, 90 | "launch": { 91 | "version": "0.2.0", 92 | "configurations": [ 93 | { 94 | "name": "Launch", 95 | "device": "nRF52840_xxAA", 96 | "cwd": "${workspaceFolder}", 97 | "executable": "build/zephyr/zephyr.elf", 98 | "request": "launch", 99 | "type": "cortex-debug", 100 | "runToEntryPoint": "main", 101 | "servertype": "jlink", 102 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb", 103 | "preLaunchTask": "West Build" 104 | }, 105 | { 106 | "name": "Attach", 107 | "device": "nRF52840_xxAA", 108 | "cwd": "${workspaceFolder}", 109 | "executable": "build/zephyr/zephyr.elf", 110 | "request": "attach", 111 | "type": "cortex-debug", 112 | "runToEntryPoint": "main", 113 | "servertype": "jlink", 114 | "gdbPath": "${userHome}/zephyr-sdk-0.16.8/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb" 115 | }, 116 | ] 117 | }, 118 | "extensions": { 119 | "recommendations": [ 120 | "ms-vscode.cpptools-extension-pack", 121 | "ms-python.python", 122 | "ms-vscode.vscode-embedded-tools", 123 | "ms-vscode.vscode-serial-monitor", 124 | "marus25.cortex-debug", 125 | "donjayamanne.python-environment-manager" 126 | ] 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------