Skip to content

Commit 272b464

Browse files
committed
Updated readme.md with instructions for using Egit.
1 parent 017724d commit 272b464

File tree

1 file changed

+38
-39
lines changed

1 file changed

+38
-39
lines changed

readme.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,48 @@
11
#Arduino-Eclipse-Plugin
22

3-
Add stuff here on normal usage
3+
This plugin helps ease you into the world of Eclipse from Arduino. 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 make writing your code easier.
44

5+
It works on MS Windows, Mac OSX and Linux.
6+
7+
TODO: More on the plugin.
8+
9+
##Installing the Plugin
10+
11+
See http://www.baeyens.it/eclipse/Install.html
512

613
##Developing (Improving) the Plugin
714

8-
Fork the repository on GitHub.
9-
Your link should look like this: https://github.com/YOUR_FORK/arduino-eclipse-plugin.git
15+
Fork the repository on GitHub (https://help.github.com/articles/fork-a-repo) for your changes.
1016

17+
Note that your git link should look like this: https://github.com/YOUR_FORK/arduino-eclipse-plugin.git -- we will use it later.
1118

12-
###Add Eclipse Plugin Development Environment into your Eclipse Environment
19+
###Add needed plugins/features into the Eclipse Environment
1320

21+
You should already have a supported Eclipse version installed (the CDT package makes a good start point). Let's add:
22+
23+
####Add Eclipse Plugin Development Environment
1424

1525
Help-> Install New Software -> Work with: -> All Available Sites
1626

17-
Now select the *Eclipse Plug-in Development Environment*
27+
Now search/select the *Eclipse Plug-in Development Environment*
1828

29+
Note: This may take a while to download all the available packages.
1930

2031
![alt text](images_plugin_dev_setup/adding_pde.png "Adding the Plugin Development Environment")
2132

22-
###Recommended plugins
23-
24-
For completeness you should install (if not already installed)
2533

26-
####The Java Development Tools
34+
####Add Eclipse Java Development Tools
2735

2836
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:
2937

30-
3138
*Help*-> *Install New Software*
3239

3340
There you select for *Work with:* *YOUR_ECLIPSE_RELEASE - http://download.eclipse.org/releases/YOUR_ECLIPSE_RELEASE*
3441

3542
There you open:
3643
*Programming Languages -> Eclipse Java Development Tools.*
3744

38-
####EGit - Eclipse Git Team Provider
45+
####Add EGit - Eclipse Git Team Provider
3946

4047
To install EGit you'll need to do the following:
4148

@@ -45,23 +52,23 @@ There have to enter the following URL and press ENTER.
4552

4653
*http://download.eclipse.org/egit/updates*
4754

48-
Now you have to open up the **Eclipse Git Team Provider** Categorry and select **Eclipse Git Team Provider** , now you just have to press next and do what the dialog tells you to do.
49-
55+
Now you have to open up the **Eclipse Git Team Provider** Category and select **Eclipse Git Team Provider** , now you just have to press next and do what the dialog tells you to do.
5056

57+
<!-- Eclipse GitHub integration with task focused interface -->
5158

5259

5360

54-
###Importing the Project
61+
###Importing the Arduino Plugin Project into Eclipse
5562

5663
After you installed all the plugins you'll need to restart Eclipse to use them.
5764

5865

59-
You will need to import the projects into Eclipse, there are two ways to do that:
66+
Then comes time to get the plugin source code in a place you can use. You will need to import the projects into Eclipse, there are two ways to do that:
6067

61-
####Via command line
68+
####1)Via command line
6269

6370

64-
If youre using Windows you should first install [GitHub for Windows](http://windows.github.com/).
71+
If you're using Windows you should first install [GitHub for Windows](http://windows.github.com/).
6572

6673
First you should open a command line, and change the directory to the directory where you want to store your Project.
6774

@@ -91,56 +98,48 @@ You will select the following:
9198
Now press Finish, and it should import the selected Projects.
9299

93100

94-
<!--
95-
via EGit interface.
101+
####2)Via EGit interface.
96102

97103
*File -> Import -> Git -> Projects from Git -> Clone URI*
98104

99105
Now type your fork in to URI, for example:
100106

101107
*https://github.com/YOUR_FORK/arduino-eclipse-plugin.git*
102108

109+
Next
103110

111+
Branch Selection: master
104112

113+
Local destination: /home/your_name/git/arduino-eclipse-plugin
114+
or c:\git\arduino-eclipse-plugin
105115

116+
Rest of page unchanged.
106117

107-
import, select, plugins, Import Plug-ins and Fragments
108-
109-
![alt text](images_plugin_dev_setup/import_select.png "Adding the Plugin Development Environment")
110-
118+
Next.
111119

112-
Import Plug-ins and Fragments
120+
Select a wizard: Import Existing Projects
113121

114-
URI
122+
Next.
115123

116-
https://github.com/YOUR_FORK/arduino-eclipse-plugin.git
124+
Import Projects
117125

118-
master
119-
120-
import all existing projects
126+
Select all the projects
121127

122128
FINISH
123-
-->
124-
125-
126-
127-
128129

129130
After all it should look like this:
130-
![alt text](images_plugin_dev_setup/Imported_projects.png "Adding the Plugin Development Environment")
131+
![alt text](images_plugin_dev_setup/Imported_projects.png "Projects imported")
131132

132-
###Set the formatting
133+
###Set the code formatting
133134
To avoid having changes all the time because of different formatting this project contains a formatting xml.
134135
Go to window->preferences->java->Code style->Formatter import codeformat.xml in the root of the repo.
135136

136137
###Running the plugin
137138

138-
139139
Then running is very simple - just right click it.bayaens.arduino.core and select *run as -> Eclipse Application* (or *debug as -> Eclipse Application* -- letting you set breakpoints)
140140

141141
Eclipse will launch a new workbench disabling the installed version if any of the plugin and updating with the plugins in the current workspace.
142142

143-
144143
images_plugin_dev_setup/running_check_versions.png
145144

146145

@@ -149,5 +148,5 @@ Preferences/Arduino to point to IDE and private libs
149148

150149
New Project, Arduino, New Arduino Sketch
151150

152-
151+
All should work. You can set breakpoints in the launching Eclipse if you ran as debug. Happy developing!
153152

0 commit comments

Comments
 (0)