Skip to content

Commit c704900

Browse files
sblivenandreasprlic
authored andcommitted
/* Cloning the repository */ Adding instructions
1 parent c959518 commit c704900

File tree

2 files changed

+86
-2
lines changed

2 files changed

+86
-2
lines changed

_wikis/BioJava3_eclipse.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,61 @@ for the repository URL. If you don't want to make a fork (for instance,
3030
if you don't plan to make any changes), you can follow the instructions
3131
below exactly.
3232

33-
*TODO: write instructions*
33+
Option 1: *Try these instructions first. If they don't work, try option
34+
2.*
35+
36+
1. Go to
37+
2. In the Maven category, select 'Check out Maven Projects from SCM'
38+
and click Next.
39+
3. Select 'git' in the dropdown box. If 'git' is not an option, make
40+
sure you have the m2e-egit connector installed as descripted below.
41+
4. Add the URL for your biojava repository on github. For instance, to
42+
checkout the main repository, use
43+
https://github.com/biojava/biojava.git
44+
45+
Make sure that 'Checkout All Projects' is selected and click Finish.
46+
47+
Option 2: *These instructions are more difficult, but may work if Option
48+
1 fails.*
49+
50+
1. Open the Git Repository View
51+
1. Go to
52+
2. Under 'Git', select 'Git Repositories'
53+
54+
2. Clone your git repository. The following is the easiest way to do
55+
this from within Eclipse, but you could also get a local clone via
56+
the command line and then add it as a local repository.
57+
1. Click the 'Clone Git Repository' icon in the Git Repository View
58+
2. Add the URL of your biojava repository on github. For instance,
59+
to checkout the main repository, use
60+
https://github.com/biojava/biojava.git
61+
62+
3. Optionally add your Github username and password, then click
63+
Next.
64+
4. Select which branches to include. If you plan to commit any
65+
changes, we recommend only tracking the 'devel' branch, so you
66+
don't accidentally initiate a release. If you want the last
67+
stable version, you can select 'release' instead. Click Next.
68+
5. Choose a destination directory (outside your Eclipse workspace),
69+
double-check your selection of Initial branch, and click Finish
70+
71+
3. Import Maven projects from the git repository.
72+
1. Right click on the biojava git repository in the Git
73+
Repositories viewer. Select 'Import Maven Projects...'
74+
2. Select all modules and click Finish
75+
76+
4. Initiate git tracking for the projects
77+
1. Select all biojava modules in the Project Explorer
78+
2. Right click and select
79+
3. Select 'Git' and click Next
80+
4. Select 'Use or create repository in parent folder of project'.
81+
This will use the local repository you cloned previously for
82+
your source code
83+
5. Finished!
84+
85+
You should now have source to all the biojava modules (biojava3-core,
86+
biojava3-structure, etc). Viewing the history for any file should show
87+
you all commits since 2009 which have contributed to that file.
3488

3589
Plugin Installation
3690
-------------------

_wikis/BioJava3_eclipse.mediawiki

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,37 @@ Eclipse is a common IDE for using BioJava.
1212

1313
We recommend [[Contributing to BioJava#Forking Biojava|creating a fork]] on github for day-to-day development. In the following instructions you should substitute something like 'https://github.com/<username>/biojava.git' for the repository URL. If you don't want to make a fork (for instance, if you don't plan to make any changes), you can follow the instructions below exactly.
1414

15-
''TODO: write instructions''
15+
Option 1:
16+
''Try these instructions first. If they don't work, try option 2.''
17+
<!-- These instructions should work and are simple, but don't work for me on ubuntu. They fail with 'No Maven projects found'~~~~ -->
18+
# Go to {{menu2|File|Import...}}
19+
# In the Maven category, select 'Check out Maven Projects from SCM' and click Next.
20+
# Select 'git' in the dropdown box. If 'git' is not an option, make sure you have the m2e-egit connector installed as descripted below.
21+
# Add the URL for your biojava repository on github. For instance, to checkout the main repository, use <pre>https://github.com/biojava/biojava.git</pre>Make sure that 'Checkout All Projects' is selected and click Finish.
22+
23+
Option 2:
24+
''These instructions are more difficult, but may work if Option 1 fails.''
25+
26+
# Open the Git Repository View
27+
## Go to {{menu3|Window|Show View|Other...}}
28+
## Under 'Git', select 'Git Repositories'
29+
# Clone your git repository. The following is the easiest way to do this from within Eclipse, but you could also get a local clone via the command line and then add it as a local repository.
30+
## Click the 'Clone Git Repository' icon in the Git Repository View
31+
## Add the URL of your biojava repository on github. For instance, to checkout the main repository, use <pre>https://github.com/biojava/biojava.git</pre>
32+
## Optionally add your Github username and password, then click Next.
33+
## Select which branches to include. If you plan to commit any changes, we recommend only tracking the 'devel' branch, so you don't accidentally initiate a release. If you want the last stable version, you can select 'release' instead. Click Next.
34+
## Choose a destination directory (outside your Eclipse workspace), double-check your selection of Initial branch, and click Finish
35+
# Import Maven projects from the git repository.
36+
## Right click on the biojava git repository in the Git Repositories viewer. Select 'Import Maven Projects...'
37+
## Select all modules and click Finish
38+
# Initiate git tracking for the projects
39+
## Select all biojava modules in the Project Explorer
40+
## Right click and select {{menu2|Team|Share Project...}}
41+
## Select 'Git' and click Next
42+
## Select 'Use or create repository in parent folder of project'. This will use the local repository you cloned previously for your source code
43+
## Finished!
44+
45+
You should now have source to all the biojava modules (biojava3-core, biojava3-structure, etc). Viewing the history for any file should show you all commits since 2009 which have contributed to that file.
1646

1747
== Plugin Installation ==
1848

0 commit comments

Comments
 (0)