Skip to content

Commit 4a15026

Browse files
committed
add new oomph setup links
- incorporate our new oomph setups and p2 repo links - some restructering of Installation and developer guide (more important topics higher up, less important to bottom of page) Signed-off-by: Christoph Rueger <chrisrueger@gmail.com>
1 parent e58a69f commit 4a15026

File tree

2 files changed

+51
-25
lines changed

2 files changed

+51
-25
lines changed

development.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,24 @@ author: Neil Bartlett
88

99
## Building Bndtools
1010

11-
Bndtools is built with Bndtools! If you want to work on the bndtools source code, you have two options:
11+
Bndtools is built with Bndtools! If you want to work on the bndtools source code, you have three options:
1212

1313
* Install the current public release of bndtools from the [Eclipse Marketplace][2] and start working straight away.
1414
* Build Bndtools from the command line, then install the build results into your Eclipse IDE.
15+
* or install one of the pre-configured [development setups](#development-setups)
1516

16-
## Checking Out from GitHub
17+
18+
### Checking Out from GitHub
1719

1820
First check out the source code from GitHub as follows:
1921

2022
git clone git://github.com/bndtools/bnd.git
2123

2224
If you have Bndtools installed in your Eclipse IDE already (e.g. using Marketplace) then skip to **Importing Into Eclipse** below. Otherwise read on...
2325

24-
## Building from the command-line
26+
### Building from the command-line
2527

26-
Read the document `BUILDING-GRADLE.md` to learn how the build works.
28+
Read the document [Contribution to Bnd/Bndtools](https://github.com/bndtools/bnd/blob/master/CONTRIBUTING.md#build-environment) to learn how the build works.
2729

2830
Assuming you have Gradle (version 1.11 or better) installed, you can build bndtools from the command line by changing to the root of your checkout and typing:
2931

@@ -35,7 +37,7 @@ To install from the generated Update Sites, open the Help menu in Eclipse and se
3537

3638
Back in the update dialog, Bndtools will appear in the category list. Place a check next to it and click Next. Drive the rest of the wizard to completion... congratulations, you have just built and installed bndtools!
3739

38-
## Importing Into Eclipse
40+
### Importing Into Eclipse
3941

4042
Now you have Bndtools installed in your Eclipse IDE, you can import the bndtools projects into Eclipse to begin working on the source code.
4143

@@ -49,6 +51,15 @@ Click "Finish"... Eclipse will start to import and build the projects. **If you
4951

5052
You should now have all the bndtools projects in your workspace, ready to begin hacking!
5153

54+
## Development Setups
55+
56+
We also provide pre-configured setups using Eclipse oomph installer, which help you getting started quickly.
57+
This way you get a dedicated Eclipse instance with pre-installed bndtools source code with a simple one-click installer.
58+
59+
Find our different setups and P2 Repositories at:
60+
<https://bndtools.org/bndtools.p2.repo/>
61+
62+
5263
## Launching Bndtools from Eclipse
5364

5465
To launch bndtools from Eclipse (e.g. to try out a change to debug), use one of the `.bndrun` files from the `bndtools.core` project. There are three launchers, one per architecture, i.e.:

installation.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,58 @@ title: Install Bndtools 7.0.0
33
---
44

55

6-
You can install Bndtools via the [Marketplace](#marketplace) or directly install from the [Update Site](#update-site)
6+
# Install Bndtools 7.0.0
77

8-
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Ry6XNGm7C-k" frameborder="1" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
8+
There are different flavors you can install Bndtools.
99

10-
To get then started with the [bndtools Workspace model](workspace.html), you can follow some videos that can get you started.
10+
## Users: If you just want to use Bndtools for your own projects
1111

12-
## Enhancements
12+
- via the [Eclipse Marketplace](#marketplace)
13+
- or directly install into Eclipse from the [Update Site](#update-site)
1314

14-
* Bndtools is built to run on Eclipse 2020-06 or later. So Bndtools 7.0.0 may not run on older versions of Eclipse.
15+
## Developers: If you want to contribute to bndtools
1516

16-
For more complete information on the changes in the Bndtools release, see <https://github.com/bndtools/bnd/wiki#release-notes>.
17+
- Setup source code into your existing Eclipse installation. See our [Bndtools Developer Guide](/development.html)
18+
19+
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Ry6XNGm7C-k" frameborder="1" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
20+
21+
To get then started with the [bndtools Workspace model](workspace.html), you can follow some videos that can get you started.
1722

18-
## Known Issues
1923

20-
* This release is based on Java 17. This tends to be not noticed for developmet but there are a number of runtime bundles in the distribution that now also have become Java 17 code. This could generate the error during a bndrun launch or with bnd/OSGi testing when the Execution Environment is set to < 17. The easy fix is to set this to 17. If this is impossible, the previous launchers than run on 1.8 can then be used (if they are available in the repositories). Add
21-
```
22-
-runpath \
23-
biz.aQute.launcher;version="[6.4.0,7)", \
24-
biz.aQute.tester.junit-platform;version="[6.4.0,7)"
25-
```
2624
## Marketplace
2725

2826
The recommended way to install Bndtools via the [Eclipse Marketplace](https://marketplace.eclipse.org/content/bndtools).
2927

30-
<a href="https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1220" class="drag" title="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client"><img typeof="foaf:Image" class="img-responsive" src="https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png" alt="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client" /></a>
28+
<a href="https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1220" class="drag" title="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client">
29+
<img style="width:80px;" typeof="foaf:Image" class="img-responsive" src="https://marketplace.eclipse.org/modules/custom/eclipsefdn/eclipsefdn_marketplace/images/btn-install.svg" alt="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client" />
30+
</a>
3131

3232
## Update Site
3333

3434
* From the Help menu select `Install New Software...`
3535
* When the dialog opens, click the `Add...` button near the top-right.
36-
* In the Name field enter `Bndtools`. In the Location field enter one of the the following URLs
36+
* In the Name field enter `Bndtools`. In the Location field enter one of the the following P2 Repository URLs
3737

38-
| Type |URL |
39-
|----------------------------|-------------------------------------------------------|
40-
| Latest stable release | https://bndtools.jfrog.io/bndtools/update-latest |
41-
| Latest release candidate | https://bndtools.jfrog.io/bndtools/update-rc |
42-
| Latest build snapshot | https://bndtools.jfrog.io/bndtools/update-snapshot |
38+
| Type |URL |alt. URL|
39+
|----------------------------|-------------------------------------------------------|--|
40+
| Latest stable release | `https://bndtools.org/bndtools.p2.repo/7.0.0/` | via [jfrog](https://bndtools.jfrog.io/bndtools/update-latest) |
41+
| Latest release candidate | `https://bndtools.jfrog.io/bndtools/update-rc` ||
42+
| Latest build snapshot | `https://bndtools.jfrog.io/bndtools/update-snapshot` ||
4343

4444
* Press `Next` and then `Finish`, acknowledging the licenses
4545

46+
## Release Notes
47+
48+
For more complete information on the changes in the Bndtools release, see <https://github.com/bndtools/bnd/wiki#release-notes>.
49+
50+
51+
## Known Issues
52+
53+
* Bndtools is built to run on Eclipse 2020-06 or later. So Bndtools 7.0.0 may not run on older versions of Eclipse.
54+
55+
* This release is based on Java 17. This tends to be not noticed for developmet but there are a number of runtime bundles in the distribution that now also have become Java 17 code. This could generate the error during a bndrun launch or with bnd/OSGi testing when the Execution Environment is set to < 17. The easy fix is to set this to 17. If this is impossible, the previous launchers than run on 1.8 can then be used (if they are available in the repositories). Add
56+
```
57+
-runpath \
58+
biz.aQute.launcher;version="[6.4.0,7)", \
59+
biz.aQute.tester.junit-platform;version="[6.4.0,7)"
60+
```

0 commit comments

Comments
 (0)