Skip to content

Commit 5d52615

Browse files
author
Akos Kitta
committed
Updated the CI config & README after the repo move
Signed-off-by: Akos Kitta <[email protected]>
1 parent bf4ee8f commit 5d52615

File tree

2 files changed

+34
-9
lines changed

2 files changed

+34
-9
lines changed

README.md

+32-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# arduino-eclipse
2-
[![Build Status](https://dev.azure.com/typefox/Arduino/_apis/build/status/TypeFox.arduino-eclipse?branchName=master)](https://dev.azure.com/typefox/Arduino/_build/latest?definitionId=6&branchName=master)
1+
# arduino-create-eclipse
2+
[![Build Status](https://dev.azure.com/typefox/Arduino/_apis/build/status/arduino.arduino-create-eclipse?branchName=master)](https://dev.azure.com/typefox/Arduino/_build/latest?definitionId=7&branchName=master)
33

44
Eclipse Plug-in for importing projects into Eclipse CDT exported by [Arduino Create](https://create.arduino.cc).
55

@@ -9,28 +9,37 @@ Eclipse Plug-in for importing projects into Eclipse CDT exported by [Arduino Cre
99
- [`make`](https://www.gnu.org/software/make/), and [`cmake`](https://cmake.org/download/) on the `PATH`.
1010

1111
### Build:
12+
Command line:
1213
```
1314
./mnvw clean verify
1415
```
1516

17+
Eclipse:
18+
- Clone the [`arduino-create-eclipse`](https://github.com/arduino/arduino-create-eclipse.git) repository and
19+
- Import the sources into your Eclipse workspace with
20+
- `Import...` > `General` > `Existing Projects into Workspace`.
21+
- `Select root directory` and browse the root of the cloned repository.
22+
- Enable `Search for nested projects`, and
23+
- Hit `Finish`
24+
1625
### Install:
1726
The easiest way to install, is to drag and drop the `Install` button into your running Eclipse workspace. This plug-in is also [available at Eclipse Marketplace](https://marketplace.eclipse.org/content/arduino-create-eclipse-plug).
1827

1928
[![Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png)](http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4895924 "Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client")
2029

2130
### p2:
22-
The p2 update sites are available for each released version on GitHub as a ZIP archive. The `latest` p2 is available [here](https://github.com/TypeFox/arduino-eclipse/releases/latest/download/arduino-eclipse-p2.zip). If you want to use the p2 update URL inside Eclipse, you **must** prefix the URL with `jar:` and suffix it with `!/`.
31+
The p2 update sites are available for each released version on GitHub as a ZIP archive. The `latest` p2 is available [here](https://github.com/arduino/arduino-create-eclipse/releases/latest/download/arduino-create-eclipse-p2.zip). If you want to use the p2 update URL inside Eclipse, you **must** prefix the URL with `jar:` and suffix it with `!/`.
2332
- URL of the `latest` p2:
2433
```
25-
jar:https://github.com/TypeFox/arduino-eclipse/releases/latest/download/arduino-eclipse-p2.zip!/
34+
jar:https://github.com/arduino/arduino-create-eclipse/releases/latest/download/arduino-create-eclipse-p2.zip!/
2635
```
2736
- Generic p2 URL pattern for any [`semver`](https://semver.org/) releases:
2837
```
29-
jar:https://github.com/TypeFox/arduino-eclipse/releases/download/v${semver}/arduino-eclipse-p2.zip!/
38+
jar:https://github.com/arduino/arduino-create-eclipse/releases/download/v${semver}/arduino-create-eclipse-p2.zip!/
3039
```
3140
- Example URL for version `0.0.1`:
3241
```
33-
jar:https://github.com/TypeFox/arduino-eclipse/releases/download/v0.0.1/arduino-eclipse-p2.zip!/
42+
jar:https://github.com/arduino/arduino-create-eclipse/releases/download/v0.0.1/arduino-create-eclipse-p2.zip!/
3443
```
3544

3645
### Arduino Create:
@@ -80,9 +89,25 @@ Currently, you can build the imported Arduino Create project on Linux only.
8089
1 error generated.
8190
```
8291

92+
### FAQ:
93+
Q: What happens when `cmake` is not installed on the system?\
94+
A: If `cmake` is not installed, you will see the following console output in Eclipse:
95+
96+
```
97+
Buildfile generation error occurred..
98+
cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=ON -G “Unix Makefiles” /home/user_name/dev/arduino-create-eclipse-ws/arduino_create-cmake
99+
Cannot run program “cmake”: Unknown reason
100+
Error: Program “cmake” not found in PATH
101+
PATH=[/home/user_name/bin:/home/user_name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin]
102+
Build stopped..
103+
```
104+
105+
Q: What happens when `cmake4eclipse` is not installed in Eclipse?\
106+
A: This Eclipse plug-in has a hard dependency on `cmake4eclipse`. It will be implicitly installed into Eclipse when this Eclipse plug-in is installed either from a p2 update site or the Eclipse Marketplace.
107+
83108
### License:
84109

85110
- This plug-in is licensed under the [`EPL-2.0`](https://www.eclipse.org/legal/epl-2.0/).
86111

87112
### Notes:
88-
- This project is built on the top of [`cmake4eclipse`](https://github.com/15knots/cmake4eclipse)🥇
113+
- This project is built on the top of [`cmake4eclipse`](https://github.com/15knots/cmake4eclipse)🥇

azure-pipelines.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ jobs:
4646
inputs:
4747
artifactName: repository
4848
downloadPath: $(System.DefaultWorkingDirectory)
49-
- bash: cd repository && zip -r -D -9 arduino-eclipse-p2.zip *
49+
- bash: cd repository && zip -r -D -9 arduino-create-eclipse-p2.zip *
5050
- task: GithubRelease@0
5151
inputs:
5252
gitHubConnection: typefox-service-account1
53-
repositoryName: TypeFox/arduino-eclipse
53+
repositoryName: arduino/arduino-create-eclipse
5454
assets: $(System.DefaultWorkingDirectory)/repository/*.zip
5555
target: $(Build.SourceVersion)
5656
action: edit

0 commit comments

Comments
 (0)