Skip to content

Commit d845b6c

Browse files
authored
#1027 Fix the readme
* We do not rely on user specific settings. Move to project.
1 parent 17ddf88 commit d845b6c

File tree

1 file changed

+16
-114
lines changed

1 file changed

+16
-114
lines changed

readme.md

Lines changed: 16 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Please install [git] (http://git-scm.com/downloads) and [maven] (http://maven.ap
3131
```bash
3232
git clone https://github.com/jantje/arduino-eclipse-plugin
3333
cd arduino-eclipse-plugin
34-
mvn clean -Dtest=RegressionTest verify
34+
mvn clean verify -DskipTests=true
3535
```
3636

3737
### Running the build from source IDE/Plugin
@@ -63,27 +63,24 @@ Mac OSX and Linux
6363

6464
You can control the maven build with the following profiles: (this list may not be complete as new eclipse versions are added nearly immediately)
6565

66-
* oxygen
67-
* neon (builds against the neon repositories (4.6))
68-
* luna (builds agains the luna repositories (4.4))
69-
* mars (builds agains the mars repositories (4.5))
66+
* latest (default, builds against the latest versions)
67+
* 2018-09 (builds against the 2018-09 release. Eclipse stopped naming their releases)
68+
* photon (builds against the photon (4.8) repositories)
69+
* oxygen (builds against the oxygen (4.7) repositories)
70+
* SDK (builds a Sloeber you can program Sloeber in. With Java.)
7071
* win32 (builds for 32 bit windows)
7172
* win64
72-
* linux32
7373
* linux64
7474
* mac64
7575

7676
##### Examples
77-
mvn verify -Plinux32 -Dtest=RegressionTest (builds for neon and linux 32 bits)
78-
mvn verify -Pwin32,mars,linux32 -Dtest=RegressionTest
79-
77+
mvn clean verify -Plinux32 -DskipTests=true (builds for neon and linux 32 bits)
78+
mvn clean verify -PSDK.latest -DskipTests=true (builds the Sloeber SDK. For Sloeber programmers.)
79+
mvn clean verify -P2018-09,linux64 -DskipTests=true (builds against 2018-09 and produces linux64 product)
80+
8081
To build for neon and the platform you are running on:
8182

82-
mvn clean verify -Dtest=RegressionTest
83-
84-
### what is this -Dtest=RegressionTest about
85-
mvn builds and run tests automagically. However many junit tests in Sloeber are very extensive and will always have failures.
86-
By adding -Dtest=RegressionTest anly the regression test is run and this test should be successfull.
83+
mvn clean verify -DskipTests=true
8784

8885
### Setting up a repository
8986

@@ -96,103 +93,18 @@ If you want to import the latest code based plugin to another Eclipse setup you
9693
* 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.
9794
* Checkout locally
9895
* Make changes
99-
* Run ```mvn clean verify -Dtest=RegressionTest``` to build
100-
* Open the self-contained IDE and verify your fix
101-
* (Anything special about Travis CI & builds?)
102-
103-
#### Adding Eclipse PDE (Plugin Development Environment)
104-
105-
You should already have a supported Eclipse version installed (the CDT package makes a good start point). Let's add:
106-
107-
> Help → Install New Software → Work with: → All Available Sites
108-
109-
Now search/select the *Eclipse Plug-in Development Environment*
110-
111-
Note: This may take a while to download all the available packages.
112-
113-
![alt text](images_plugin_dev_setup/adding_pde.png "Adding the Plugin Development Environment")
114-
115-
116-
#### Adding Eclipse JDT (Java Development Tools)
117-
118-
If you're not using Eclipse with the JDT you'll need to install them. To do this you first need to open the Dialog for installing new Software:
119-
120-
> Help → Install New Software
121-
122-
There you select for *Work with:* *YOUR_ECLIPSE_RELEASE - http://download.eclipse.org/releases/YOUR_ECLIPSE_RELEASE*
123-
124-
After that, select
125-
126-
> Programming Languages → Eclipse Java Development Tools
127-
128-
#### Add EGit - Eclipse Git Team Provider
129-
130-
To install EGit you'll need to do the following:
131-
132-
> Help → Install New Software
133-
134-
There have to enter the following URL and press ENTER.
135-
136-
* http://download.eclipse.org/egit/updates
137-
138-
Now you have to open up the *Eclipse Git Team Provider* Category and select *Eclipse Git Team Provider*.
139-
Then press next and follow the instructions.
140-
141-
#### Add nebula (for the plotter)
142-
To install nebula you need the snapshot
143-
144-
> Help → Install New Software
145-
146-
There have to enter the following URL and press ENTER.
147-
* http://download.eclipse.org/nebula/releases/latest/
148-
149-
Now you have to open up the *Nebula Release all widgets and examples* Category and select *Nebula widgets*.
150-
Then press next and follow the instructions.
96+
* Run ```mvn clean verify -PSDK,latest -DskipTests=true``` to build
15197

98+
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)
15299

153-
### Importing an Arduino Plugin Project into Eclipse
100+
Note that Sloeber itself is NOT included in the Sloeber SDK.
154101

155-
After you installed all the plugins you'll need to restart Eclipse.
156102

157-
Eventually your plugin source code will be ready to be used with Eclipse. There are two ways to import your projects into Eclipse:
158-
159-
#### 1. Via a Command Line
160-
161-
If you're using Windows you should first install [GitHub for Windows](http://windows.github.com/).
162-
163-
First you should open a command line, and change the directory to the directory where you want to store your Project.
164-
165-
Now you have to clone your Fork:
166-
167-
```bash
168-
git clone https://github.com/YOUR_FORK/arduino-eclipse-plugin.git
169-
```
170-
171-
After that you should import the Project to Eclipse:
172-
173-
> File → Import → Plug-in Development → Plug-ins and Fragments
174-
175-
You should select all as shown in this picture.
176-
177-
![alt text](images_plugin_dev_setup/plugins_import_config.png "Adding the Plugin Development Environment")
178-
179-
You may need to change the directory to match the directory where you cloned the project into.
180-
181-
Press Next.
182-
183-
In the next window you have to select which Plug-in fragments you want to import.
184-
Select all that are appropriate:
185-
186-
![alt text](images_plugin_dev_setup/plugins_select.png "Adding the Plugin Development Environment")
187-
188-
Now press Finish, and it should import the selected Projects.
189-
190-
191-
#### 2. Via EGit interface.
103+
### Install the projects into the SDK via the EGit interface.
192104

193105
> File → Import → Git → Projects from Git → Clone URI
194106
195-
* Now type your fork in to URI, for example: ```https://github.com/YOUR_FORK/arduino-eclipse-plugin.git```
107+
* Now type your fork in to URI, for example: ```https://github.com/YOUR_USER/arduino-eclipse-plugin.git```
196108
* Press "Next".
197109
* Branch Selection: master
198110
* Local destination: ```/home/your_name/git/arduino-eclipse-plugin``` or ```c:\git\arduino-eclipse-plugin```
@@ -208,16 +120,6 @@ After all it should look like this:
208120

209121
![alt text](images_plugin_dev_setup/Imported_projects.png "Projects imported")
210122

211-
### Set the Code Formatting
212-
213-
To avoid having changes all the time because of different formatting this project uses the standard "Eclipse [built-in]".
214-
215-
Go to
216-
217-
> Window → Preferences → Java → Code Style → Formatter
218-
219-
and check this setting.
220-
221123
### Set the Warning Level
222124

223125
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

0 commit comments

Comments
 (0)