Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 20003fb

Browse files
After some reformatting.
1 parent cfa562e commit 20003fb

File tree

1 file changed

+89
-41
lines changed

1 file changed

+89
-41
lines changed

‎README.md‎

Lines changed: 89 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Our current development environment is going to consist of:
77
3. Eclipse with git integration
88

99
## 1. Ubuntu 18.04 LTS
10-
This guide is not going to cover the installation and configuration of the OS or the tools and utilities used to reach this point but they are confirmed here for completeness:
10+
This guide is not going to cover the installation and configuration of the OS
11+
or the tools and utilities used to reach this point but they are
12+
confirmed here for completeness:
1113
- [ ] Next clean installation change this section to include the details on how to check for and correctly install some of the utilities, especially cover ssh key file permissions.
1214
- Ubuntu 18.04 LTS
1315
- git-core
@@ -18,7 +20,9 @@ This guide is not going to cover the installation and configuration of the OS or
1820
Unless it is stated differently, all commands should be entered using the Terminal.
1921

2022
## 2. asdf
21-
This will enable us to not only install our JDKs but also switch between them on a per project basis, install the core of the utility following the instructions here: https://github.com/asdf-vm/asdf
23+
This will enable us to not only install our JDKs but also switch between them
24+
on a per project basis, install the core of the utility following
25+
the instructions here: https://github.com/asdf-vm/asdf
2226

2327
Close the Terminal and start a new one so that the changes
2428
can take effect.
@@ -37,20 +41,23 @@ We're going to install Java oracle-8.181:(While we still can!)
3741
```
3842
asdf install java oracle-8.181
3943
```
40-
The command initiates the download of the selected JDK which can take a while, but once complete the JDK should have been successfully installed.
44+
The command initiates the download of the selected JDK which can take a while,
45+
but once complete the JDK should have been successfully installed.
4146

4247
We'll use this version system wide:
4348
```
4449
asdf global java oracle-8.181
4550
```
46-
But once setup properly you could use different versions per project by setting the asdf java on that directory.
51+
But once setup properly you could use different versions per project by setting
52+
the asdf java on that directory.
4753

4854
Check for the current version with:
4955
```
5056
asdf current java
5157
```
5258

53-
Since we applied our version globally running the following anywhere should confirm the asdf settings:
59+
Since we applied our version globally running the following anywhere should
60+
confirm the asdf settings:
5461
```
5562
java -version
5663
```
@@ -63,16 +70,19 @@ Which should point to your version of the shims file:
6370
```
6471
/home/yourusername/.asdf/shims/java
6572
```
66-
Intrepid readers can learn more about shims here (https://en.wikipedia.org/wiki/Shim_(computing))
73+
Intrepid readers can learn more about shims
74+
here (https://en.wikipedia.org/wiki/Shim_(computing))
6775

68-
If during some future tinkering you need to modify something about your locally installed versions of the JDK then you can find the install directories here:
76+
If during some future tinkering you need to modify something about your locally
77+
installed versions of the JDK then you can find the install directories here:
6978
```
7079
/home/yourusername/.asdf/installs/java
7180
```
7281

7382

7483
## 3. Eclipse
75-
We will install Eclipse Photon in this guide, download it from https://www.eclipse.org/downloads/
84+
We will install Eclipse Photon in this guide, download it
85+
from https://www.eclipse.org/downloads/
7686

7787
From your Downloads directory:
7888
```
@@ -89,7 +99,8 @@ Launch the GUI installer with:
8999
~/Downloads/eclipse-installer/eclipse-inst
90100
```
91101

92-
You can select whichever version you wish but if you want to follow this guide then choose:
102+
You can select whichever version you wish but if you want to follow this guide
103+
then choose:
93104
```
94105
Eclipse IDE for Java EE Developers
95106
```
@@ -99,24 +110,38 @@ Accept the default installation folder which should be your version of:
99110
/home/yourusername/eclipse/jee-photon
100111
```
101112

102-
Read and accept the licenses. When the installation completes, choose the launch option; the first action is to select a directory as a workspace, you can select any directory but of you want to follow this guide exactly then set it to:
113+
Read and accept the licenses. When the installation completes, choose the
114+
launch option; the first action is to select a directory as a workspace,
115+
you can select any directory but of you want to follow this guide exactly
116+
then set it to:
103117
```
104118
/home/yourusername/Studio/Dev/eclipse-workspace
105119
```
106-
Once Eclipse has started you may dismiss the Welcome screen and uncheck the "Always show Welcome at start up" option, unless you like it and want to be welcomed every time, totally up to you.
120+
Once Eclipse has started you may dismiss the Welcome screen and uncheck the
121+
"Always show Welcome at start up" option, unless you like it and want to be
122+
welcomed every time, totally up to you.
107123

108124
## 4. Version control with Git and Eclipse Egit
109125

110-
This section covers a few large and complicated topics, we don't have the scope here to cover them in detail, but here are some links please take the time to read each one you are not familiar with.
126+
This section covers a few large and complicated topics, we don't have the scope
127+
here to cover them in detail, but here are some links please take the time to
128+
read each one you are not familiar with.
111129

112130
### 4.1 Version control and Git
113-
If you're here there's a good chance you know what version control is, if not just know it's a type of system used by developers to manage the source code they write. Obviously there is a lot more to it than that and the following link provides an excellent overview of how Git works and compares it to some of the other systems. [Git for Eclipse Users]http://wiki.eclipse.org/EGit/Git_For_Eclipse_Users
131+
If you're here there's a good chance you know what version control is, if not
132+
just know it's a type of system used by developers to manage the source code
133+
they write. Obviously there is a lot more to it than that and the following
134+
link provides an excellent overview of how Git works and compares it to some of
135+
the other systems.
136+
[Git for Eclipse Users]http://wiki.eclipse.org/EGit/Git_For_Eclipse_Users
114137

115138
### 4.2 Installing EGit
116-
Our version of Eclipse already as Egit installed. We will confirm this in the next section.
139+
Our version of Eclipse already as Egit installed. We will confirm this in
140+
the next section.
117141

118142
### 4.3 EGit User Guides
119-
The guides listed in this section are extensive covering many aspects of EGit you may not use, but it might be good to know they exist.
143+
The guides listed in this section are extensive covering many aspects of
144+
EGit you may not use, but it might be good to know they exist.
120145

121146
> You may jump to the next section to continue with a simple
122147
> step-by-step guide, but remember the guides listed here
@@ -127,45 +152,61 @@ The guides listed in this section are extensive covering many aspects of EGit yo
127152

128153
## 5. Step-by-step: Setting up your local Eclipse Git friendly Workspace
129154
### Step 1: Where's git? Egit? ...anyone?
130-
From the main Eclipse window navigate to **Window** > **Show View** > **Other** this will open the **Show View** window.
155+
From the main Eclipse window navigate to
156+
**Window** > **Show View** > **Other** this will open the **Show View** window.
131157
![](images/screenshots/01-1-Menus.png?raw=true)
132158

133-
In the search bar enter *'Git'* if everything is installed correctly this will display a list of the available Git views. If the *'Git'* options are not displayed then you will need to perform some troubleshooting which is beyond the scope of the current guide; but as a hint make sure you've installed the correct version of Eclipse.
159+
In the search bar enter *'Git'* if everything is installed correctly this will
160+
display a list of the available Git views. If the *'Git'* options are
161+
not displayed then you will need to perform some troubleshooting which is
162+
beyond the scope of the current guide; but as a hint make sure you've
163+
installed the correct version of Eclipse.
134164
![](images/screenshots/02-Menus.png?raw=true)
135165

136-
While we're here let's add the **Git Repositories** view to our workspace by selecting it and choosing **Open**.
166+
While we're here let's add the **Git Repositories** view to our workspace
167+
by selecting it and choosing **Open**.
137168

138169
It might be added to the bottom part of your workspace like this:
139170
![](images/screenshots/03-1-MoveWindow.png?raw=true)
140171

141-
I prefer to have it to the left, next to the **Project View** you can simply drag it by clicking in the *title bar* and moving it to your desired destination.
172+
I prefer to have it to the left, next to the **Project View** you can simply
173+
drag it by clicking in the *title bar* and moving it to your desired destination.
142174
Like this:
143175
![](images/screenshots/04-MoveWindow.png?raw=true)
144176

145177
### Step 2: Clone GitHub projects
146-
There are many (...well a few) ways to clone these cats... umm sorry projects. We'll start with the simplest and work our way up.
178+
There are many (...well a few) ways to clone these cats... umm sorry projects.
179+
We'll start with the simplest and work our way up.
147180

148181
**Using HTTPS**
149-
In a web browser navigate to a GitHub project home of your choice, but definitely choose to go to this one if you're following the guide closely:
182+
In a web browser navigate to a GitHub project home of your choice, but
183+
definitely choose to go to this one if you're following the guide closely:
150184
![test-github-clone](https://github.com/ockertbotha/test-github-clone)
151185

152-
On the page; make sure you're viewing the **<> Code** tab, click on the *'Clone or download'* button, if the box opens up a **Clone with SSH** title,
186+
On the page; make sure you're viewing the **<> Code** tab, click on the
187+
*'Clone or download'* button, if the box opens up a **Clone with SSH** title,
153188
click the *'Use HTTPS'* link.
154189
![](images/screenshots/05-1-GithubFirstCloneSSH.png?raw=true)
155190

156-
With the **Clone with HTTPS** details showing you can copy the URL by clicking the copy button.
191+
With the **Clone with HTTPS** details showing you can copy the URL by
192+
clicking the copy button.
157193
![](images/screenshots/06-1-GithubFirstCloneHTTP.png?raw=true)
158194

159-
From the **Git Repositories** view we opened earlier click on the *'Clone a Git repository'* link this will open the *'Clone Git Repository'* window,
160-
paste the URL we copied from *'GitHub'* into the URI field the rest of the underlined fields automatically populate after the paste,
161-
but check that they match the values below. For this type of *'Clone'* we won't need any authentication and you may click *'Next'*.
195+
From the **Git Repositories** view we opened earlier click on the
196+
*'Clone a Git repository'* link this will open the *'Clone Git Repository'*
197+
window, paste the URL we copied from *'GitHub'* into the URI field the
198+
rest of the underlined fields automatically populate after the paste,
199+
but check that they match the values below. For this type of *'Clone'*
200+
we won't need any authentication and you may click *'Next'*.
162201
![](images/screenshots/07-EgitSourceSetting.png?raw=true)
163202

164-
When the *'Branch Selection'* window launches it should have selected the *'master'* by default, if not then make sure it is selected, and click *'next'*.
203+
When the *'Branch Selection'* window launches it should have selected the
204+
*'master'* by default, if not then make sure it is selected, and click *'next'*.
165205
![](images/screenshots/08-EgitBranchSelection.png?raw=true)
166206

167207

168-
Since we're keeping things simple this time around, in the *'Local Destination'* window change the value of the *'Directory'* field to:
208+
Since we're keeping things simple this time around, in the *'Local Destination'*
209+
window change the value of the *'Directory'* field to:
169210
```
170211
/home/yourusername/Studio/Dev/test-github-clone
171212
```
@@ -175,20 +216,24 @@ and click *'Finish'*.
175216
Voila! The project is cloned.
176217
![](images/screenshots/10-EgitCloneComplete.png?raw=true)
177218

178-
Let's use the Terminal to take a look at what was cloned, the first command navigates us to the correct starting place for the commmands
179-
that follow, but as long as the path given to any of the commands resolves correctly you can do this anyway you like:
219+
Let's use the Terminal to take a look at what was cloned, the first command
220+
navigates us to the correct starting place for the commmands
221+
that follow, but as long as the path given to any of the commands
222+
resolves correctly you can do this anyway you like:
180223
```
181224
cd ~/Studio/Dev
182225
183226
tree test-github-clone/
184227
```
185228
![](images/screenshots/11-TreeOnTestProject.png?raw=true)
186229

187-
As you can see there is currently only the README.md file in the root of the project, this might change
188-
as we test a few concepts but as long as you have the directory and some files you're good.
230+
As you can see there is currently only the README.md file in the root of the
231+
project, this might change as we test a few concepts but as long as you have
232+
the directory and some files you're good.
189233

190-
That view of the project is as much as we are really interested in, but of course there is a lot more to a git project
191-
and if you interested to see the full scope of what we have cloned you can run the following command:
234+
That view of the project is as much as we are really interested in, but of
235+
course there is a lot more to a git project and if you interested to see the
236+
full scope of what we have cloned you can run the following command:
192237
```
193238
tree -lsa test-github-clone/
194239
```
@@ -202,13 +247,15 @@ tree -lsa test-github-clone/
202247
> any Eclipse specific files we'll keep Eclipse away from the Project directory.
203248
204249
### Step 3: Managing a project in Eclipse Workspace
205-
First we'll import the cloned project into our workspace. On the *'Git'* tab, select the cloned project, right-click to launch
206-
the context-sensitive menu and select *'Import Projects'*
250+
First we'll import the cloned project into our workspace. On the *'Git'* tab,
251+
select the cloned project, right-click to launch
252+
the context-sensitive menu and select *'Import Projects'*.
207253
![](images/screenshots/13-EclipseImportProjectMenu.png?raw=true)
208254

209-
We're keeping things simple so, on the *'Import Projects...'* window that opens
210-
make sure that the path of the *'Import Source'* field points to the root
211-
of the cloned project and select *'Finish'*.
255+
We're keeping things simple with a plain import so, on the
256+
*'Import Projects...'* window that opens make sure that the path of the
257+
*'Import Source'* field points to the root of the cloned project and select
258+
*'Finish'*.
212259
![](images/screenshots/14-EclipseImportProject.png?raw=true)
213260

214261
Once the import has completed the project including the README.md is available
@@ -220,7 +267,8 @@ Make changes: branch? / commit.
220267
Delete project.
221268

222269
### Step 4: Add a local git project
223-
You can clone git repo from anywhere and even keep them local, which doesn't seem like a good idea for anything that would be worth creating a repo for in the first place,
224-
but just so that we can say "We Got The T-Shirt" here we go...
270+
You can clone git repo from anywhere and even keep them local, which doesn't
271+
seem like a good idea for anything that would be worth creating a repo for in
272+
the first place, but just so that we can say "We Got The T-Shirt" here we go...
225273

226274
### Step 5: Getting SSH Access to a GitHub Repository

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /