Skip to content

Commit 9078f4c

Browse files
author
jantje
committed
updated the readme that the SDK needs additional setup work
1 parent 1b06bcc commit 9078f4c

File tree

1 file changed

+166
-152
lines changed

1 file changed

+166
-152
lines changed

‎readme.md

+166-152
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,166 @@
1-
# Sloeber, the Arduino IDE for Eclipse <img style="float: right" src="https://avatars2.githubusercontent.com/u/25158881?v=3&s=200" height="50"/>
2-
3-
The Eclipse IDE (Integrated Developement Environment) is a full featured programming editor with many fantastic features to help you code more quickly and easily. The Arduino IDE is great for what it does – but it doesn't do much to help writing, navigating and understanding your (and other people's) code.
4-
5-
The Sloeber IDE bridges that gap and helps move you to a more powerful development environment whilst keeping the Arduino hardware and libraries that you love (and make life simple).
6-
7-
Software Logic to program Open Electronic Boards in an Eclipse Runtime (SLOEBER)
8-
9-
It works on MS Windows, Mac OSX and Linux.
10-
11-
# Downloads
12-
If you are not a developer and don't want to build from sources, then there are precompiled product packages and update sites available. You can find them here on github as releases. See the details at http://baeyens.it/.
13-
14-
# Build from source
15-
Below are instructions on how to download and compile the source code from the command line and from eclipse.
16-
You only need to do one.
17-
18-
19-
## Prerequisites
20-
Please install [git](http://git-scm.com/downloads) and [maven](http://maven.apache.org/download.cgi).
21-
22-
Java 17 is required.
23-
24-
A 64-bit OS is required.
25-
26-
27-
## Build from the command line from source for your os and the default eclipse instance
28-
```bash
29-
git clone https://github.com/Sloeber/arduino-eclipse-plugin sloeber
30-
cd sloeber
31-
mvn clean verify -DskipTests=true
32-
```
33-
34-
## Running the Sloeber you just build
35-
36-
Windows
37-
38-
* win32x64.cmd (if you are on 64 bits windows)
39-
40-
Mac OSX and Linux
41-
42-
* ./build_then_launch_plugin.sh
43-
44-
45-
## Build Options
46-
47-
You can control the maven build with the following profiles:
48-
49-
* latest (default, builds against the latest versions)
50-
* SDK (builds a Sloeber you can program Sloeber in. With Java.)
51-
* win64
52-
* linux64
53-
* mac64
54-
* macm1
55-
56-
### Examples
57-
58-
* Build the latest version for the platform you are running on:
59-
60-
`mvn clean verify -PNOSDK -DskipTests=true`
61-
62-
* Build Eclipse + Sloeber for 64-bit Windows:
63-
`mvn clean verify -Pwin64,latest,NOSDK -DskipTests=true`
64-
65-
* Build Eclipse + Sloeber for 64-bit Linux:
66-
`mvn clean verify -Plinux64,latest,NOSDK -DskipTests=true`
67-
68-
* Build the Sloeber SDK for 64-bit Windows (for Sloeber programmers):
69-
`mvn clean verify -PSDK,win64,latest -DskipTests=true`
70-
71-
# Importing your build into another Eclipse
72-
If you want to import the latest code based plugin to another Eclipse setup you have then it is possible to setup a local repository to install the plugin you have just built. Just add a local repository with location ```arduino-eclipse-plugin/io.sloeber.product/target/repository```
73-
74-
![alt text](images_plugin_dev_setup/add_local_repository.png "Adding a local repository")
75-
76-
# Developing (Improving) the Plugin
77-
* Fork the repository on GitHub (https://help.github.com/articles/fork-a-repo) for your changes. Note that your git link should look like this: https://github.com/YOUR_FORK/arduino-eclipse-plugin.git –– we will use it later.
78-
* Checkout locally
79-
* Run ```mvn clean verify -PSDK,latest -DskipTests=true``` to build
80-
81-
After the build, find the Sloeber SDK product in the io.sloeber.product.sdk target directory. Unzip it somewhere in your home directory (mind you we cannot handle very long path names on windows)
82-
83-
Note that Sloeber itself is NOT included in the Sloeber SDK.
84-
85-
86-
## Install the projects into the SDK via the EGit interface.
87-
88-
> File → Import → Git → Projects from Git → Existing local repository
89-
90-
* Now add the repository you just cloned
91-
* Press "Next".
92-
* Next
93-
* Select a wizard: Import Existing Projects
94-
* Next
95-
* Import Projects
96-
* Select all the projects
97-
* Finish
98-
99-
After all it should look like this:
100-
101-
![alt text](images_plugin_dev_setup/Imported_projects.png "Projects imported")
102-
103-
## Set the Warning Level
104-
105-
We want to keep the chance of missing a problem in the code to a minimum and to keep clean and tidy code. Development is
106-
aiming to keep compiler warnings to a minimum (items that show up in the Problems tab under Warnings) with specific settings.
107-
Please change your settings from default as follows:
108-
109-
Go to
110-
111-
> Window → Preferences → Java → Compiler → Errors/Warnings
112-
113-
and change the following from their defaults.
114-
115-
My current settings are as follows:
116-
117-
![alt text](images_plugin_dev_setup/Screenshot-Preferences1.png "screen capture")
118-
![alt text](images_plugin_dev_setup/Screenshot-Preferences 2.png "screen capture")
119-
![alt text](images_plugin_dev_setup/Screenshot-Preferences 3.png "screen capture")
120-
![alt text](images_plugin_dev_setup/Screenshot-Preferences 4.png "screen capture")
121-
![alt text](images_plugin_dev_setup/Screenshot-Preferences 5.png "screen capture")
122-
123-
* Name shadowing and conflicts: Set all to Warning.
124-
* Unnecessary code: Set all to Warning.
125-
* Null analysis: Set all active (not greyed out) to Warning.
126-
* Potential programming problems: Set all to Warning.
127-
128-
### Running Sloeber with local changes (Testing your stuff)
129-
Running is very simple - just right click io.sloeber.core and select:
130-
131-
> Run as → Eclipse Application
132-
133-
OR, if you'd like to debug,
134-
135-
> Debug as → Eclipse Application
136-
137-
Eclipse will launch a new workbench disabling the installed version if any, and updating it with the plugin version loaded in the current workspace.
138-
139-
![](images_plugin_dev_setup/running_check_versions.png "screen capture")
140-
141-
Now, just set up fresh again with your project settings, Preferences/Arduino, to point to IDE and private libs.
142-
143-
> New Project → Arduino → New Arduino Sketch
144-
145-
All should work. You can set breakpoints in the launching Eclipse if you ran as debug. Happy developing!
146-
147-
[<img border="0" style="border-width: 0px" src="http://with-eclipse.github.io/with-eclipse-1.jpg">](http://with-eclipse.github.io/)
148-
149-
# FAQ
150-
## There are lots of issues in the release that seem fixed.
151-
We close issues when they have been validated as part of the nightly. Therefore the open list no longer contains items fixed in the nightly. Known issue fixed in the last nightly can be found with this query:
152-
is:issue is:closed -label:"status: fixed in nightly"
1+
# Sloeber, the Arduino IDE for Eclipse <img style="float: right" src="https://avatars2.githubusercontent.com/u/25158881?v=3&s=200" height="50"/>
2+
3+
The Eclipse IDE (Integrated Developement Environment) is a full featured programming editor with many fantastic features to help you code more quickly and easily. The Arduino IDE is great for what it does – but it doesn't do much to help writing, navigating and understanding your (and other people's) code.
4+
5+
The Sloeber IDE bridges that gap and helps move you to a more powerful development environment whilst keeping the Arduino hardware and libraries that you love (and make life simple).
6+
7+
Software Logic to program Open Electronic Boards in an Eclipse Runtime (SLOEBER)
8+
9+
It works on MS Windows, Mac OSX and Linux.
10+
11+
# Downloads
12+
If you are not a developer and don't want to build from sources, then there are precompiled product packages and update sites available. You can find them here on github as releases. See the details at http://baeyens.it/.
13+
14+
# Build from source
15+
Below are instructions on how to download and compile the source code from the command line and from eclipse.
16+
You only need to do one.
17+
18+
19+
## Prerequisites
20+
Please install [git](http://git-scm.com/downloads) and [maven](http://maven.apache.org/download.cgi).
21+
22+
Java 17 is required.
23+
24+
A 64-bit OS is required.
25+
26+
27+
## Build from the command line from source for your os and the default eclipse instance
28+
```bash
29+
git clone https://github.com/Sloeber/arduino-eclipse-plugin sloeber
30+
cd sloeber
31+
mvn clean verify -DskipTests=true
32+
```
33+
34+
## Running the Sloeber you just build
35+
36+
Windows
37+
38+
* win32x64.cmd (if you are on 64 bits windows)
39+
40+
Mac OSX and Linux
41+
42+
* ./build_then_launch_plugin.sh
43+
44+
45+
## Build Options
46+
47+
You can control the maven build with the following profiles:
48+
49+
* latest (default, builds against the latest versions)
50+
* SDK (builds a Sloeber you can program Sloeber in. With Java.)
51+
* win64
52+
* linux64
53+
* mac64
54+
* macm1
55+
56+
### Examples
57+
58+
* Build the latest version for the platform you are running on:
59+
60+
`mvn clean verify -PNOSDK -DskipTests=true`
61+
62+
* Build Eclipse + Sloeber for 64-bit Windows:
63+
`mvn clean verify -Pwin64,latest,NOSDK -DskipTests=true`
64+
65+
* Build Eclipse + Sloeber for 64-bit Linux:
66+
`mvn clean verify -Plinux64,latest,NOSDK -DskipTests=true`
67+
68+
* Build the Sloeber SDK for 64-bit Windows (for Sloeber programmers):
69+
`mvn clean verify -PSDK,win64,latest -DskipTests=true`
70+
71+
# Importing your build into another Eclipse
72+
If you want to import the latest code based plugin to another Eclipse setup you have then it is possible to setup a local repository to install the plugin you have just built. Just add a local repository with location ```arduino-eclipse-plugin/io.sloeber.product/target/repository```
73+
74+
![alt text](images_plugin_dev_setup/add_local_repository.png "Adding a local repository")
75+
76+
# Developing (Improving) the Plugin
77+
* Fork the repository on GitHub (https://help.github.com/articles/fork-a-repo) for your changes. Note that your git link should look like this: https://github.com/YOUR_FORK/arduino-eclipse-plugin.git –– we will use it later.
78+
* Checkout locally
79+
* Run ```mvn clean verify -PSDK,latest -DskipTests=true``` to build
80+
81+
After the build, find the Sloeber SDK product in the io.sloeber.product.sdk target directory. Unzip it somewhere in your home directory (mind you we cannot handle very long path names on windows)
82+
83+
Note that Sloeber itself is NOT included in the Sloeber SDK.
84+
85+
## Install the maven PDE integration in your eclipse install.
86+
In the menu select help->install new software
87+
in the field work with enter: http://download.eclipse.org/releases/latest
88+
in the field below enter m2e
89+
select m2e - pde integration
90+
select next and finish the install
91+
92+
93+
94+
## Install the projects into the SDK via the EGit interface.
95+
96+
97+
> File → Import → Git → Projects from Git → Existing local repository
98+
99+
* Now add the repository you just cloned
100+
* Press "Next".
101+
* Next
102+
* Select a wizard: Import Existing Projects
103+
* Next
104+
* Import Projects
105+
* Select all the projects
106+
* Finish
107+
108+
After all it should look like this:
109+
110+
![alt text](images_plugin_dev_setup/Imported_projects.png "Projects imported")
111+
112+
## set the target platform
113+
in the menu select windows->preferences
114+
select plugindevelopment->target platform
115+
select Sloeber as target platform
116+
117+
## Set the Warning Level
118+
119+
We want to keep the chance of missing a problem in the code to a minimum and to keep clean and tidy code. Development is
120+
aiming to keep compiler warnings to a minimum (items that show up in the Problems tab under Warnings) with specific settings.
121+
Please change your settings from default as follows:
122+
123+
Go to
124+
125+
> Window → Preferences → Java → Compiler → Errors/Warnings
126+
127+
and change the following from their defaults.
128+
129+
My current settings are as follows:
130+
131+
![alt text](images_plugin_dev_setup/Screenshot-Preferences1.png "screen capture")
132+
![alt text](images_plugin_dev_setup/Screenshot-Preferences 2.png "screen capture")
133+
![alt text](images_plugin_dev_setup/Screenshot-Preferences 3.png "screen capture")
134+
![alt text](images_plugin_dev_setup/Screenshot-Preferences 4.png "screen capture")
135+
![alt text](images_plugin_dev_setup/Screenshot-Preferences 5.png "screen capture")
136+
137+
* Name shadowing and conflicts: Set all to Warning.
138+
* Unnecessary code: Set all to Warning.
139+
* Null analysis: Set all active (not greyed out) to Warning.
140+
* Potential programming problems: Set all to Warning.
141+
142+
### Running Sloeber with local changes (Testing your stuff)
143+
Running is very simple - just right click io.sloeber.core and select:
144+
145+
> Run as → Eclipse Application
146+
147+
OR, if you'd like to debug,
148+
149+
> Debug as → Eclipse Application
150+
151+
Eclipse will launch a new workbench disabling the installed version if any, and updating it with the plugin version loaded in the current workspace.
152+
153+
![](images_plugin_dev_setup/running_check_versions.png "screen capture")
154+
155+
Now, just set up fresh again with your project settings, Preferences/Arduino, to point to IDE and private libs.
156+
157+
> New Project → Arduino → New Arduino Sketch
158+
159+
All should work. You can set breakpoints in the launching Eclipse if you ran as debug. Happy developing!
160+
161+
[<img border="0" style="border-width: 0px" src="http://with-eclipse.github.io/with-eclipse-1.jpg">](http://with-eclipse.github.io/)
162+
163+
# FAQ
164+
## There are lots of issues in the release that seem fixed.
165+
We close issues when they have been validated as part of the nightly. Therefore the open list no longer contains items fixed in the nightly. Known issue fixed in the last nightly can be found with this query:
166+
is:issue is:closed -label:"status: fixed in nightly"

0 commit comments

Comments
 (0)