Skip to content

Commit 80a5dd1

Browse files
committed
add oomph setup links
Signed-off-by: Christoph Rueger <[email protected]> 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) add new oomph setup links add Getting Started links to install page and restructure / rename sidebar slightly
1 parent e58a69f commit 80a5dd1

File tree

3 files changed

+84
-45
lines changed

3 files changed

+84
-45
lines changed

_data/sidebar.yml

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,34 @@ nav:
88
- divider: true
99
- title: Documentation
1010
links:
11-
- name: Installation
11+
- name: Getting Started
1212
url: "/installation.html"
13-
- name: Tutorial
14-
url: "/tutorial.html"
15-
- name: Video Tour
16-
url: "/workspace.html"
1713
- name: Concepts
1814
url: "/concepts.html"
15+
- name: Video Tour
16+
url: "/workspace.html"
17+
- name: Tutorial
18+
url: "/tutorial.html"
1919
- name: OSGi with bndtools
2020
url: "/workspace/osgi-starter.html"
2121
- name: FAQ
2222
url: "/faq.html"
23-
- name: The UI
23+
- title: User Interface
24+
links:
25+
- name: Introduction
2426
url: "/manual/about.html"
25-
sublinks:
26-
- name: Bndtools Explorer
27-
url: "/manual/packageexplorer.html"
28-
- name: Repositories View
29-
url: "/manual/repositories-view.html"
30-
- name: Resolution View
31-
url: "/manual/resolution-view.html"
32-
- name: The bnd Editor
33-
url: "/manual/bndeditor.html"
34-
- name: The JAR Viewer
35-
url: "/manual/jareditor.html"
36-
- name: Project Templates
37-
url: "/manual/templates.html"
27+
- name: Bndtools Explorer
28+
url: "/manual/packageexplorer.html"
29+
- name: Repositories View
30+
url: "/manual/repositories-view.html"
31+
- name: Resolution View
32+
url: "/manual/resolution-view.html"
33+
- name: The bnd Editor
34+
url: "/manual/bndeditor.html"
35+
- name: The JAR Viewer
36+
url: "/manual/jareditor.html"
37+
- name: Project Templates
38+
url: "/manual/templates.html"
3839
- title: null
3940
links:
4041
- name: bnd manual

development.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,32 @@ author: Neil Bartlett
66

77
**This page is a tutorial for developers wishing to customise and enhance Bndtools itself.** For general documentation please refer to the [Tutorial][1].
88

9+
10+
There are two ways you can setup a development environment for contributing to Bnd/Bndtools:
11+
12+
1. [Building Bndtools](#building-bndtools) manually: Clone git, build and setup Eclipse.
13+
2. or install our [Development Setups](#development-setups) with a pre-configured Eclipse instance
14+
915
## Building Bndtools
1016

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

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

16-
## Checking Out from GitHub
24+
### Checking Out from GitHub
1725

1826
First check out the source code from GitHub as follows:
1927

2028
git clone git://github.com/bndtools/bnd.git
2129

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

24-
## Building from the command-line
32+
### Building from the command-line
2533

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

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

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

3644
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!
3745

38-
## Importing Into Eclipse
46+
### Importing Into Eclipse
3947

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

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

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

60+
## Development Setups
61+
62+
We also provide pre-configured setups using Eclipse oomph installer, which help you getting started quickly.
63+
This way you get a dedicated Eclipse instance with pre-installed bndtools source code with a simple one-click installer.
64+
65+
Find our different setups and P2 Repositories at:
66+
<https://bndtools.org/bndtools.p2.repo/>
67+
68+
5269
## Launching Bndtools from Eclipse
5370

5471
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: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,66 @@
11
---
2-
title: Install Bndtools 7.0.0
2+
title: Installation & Getting Started with Bndtools 7.0.0
33
---
44

5+
There are different flavors you can install Bndtools.
56

6-
You can install Bndtools via the [Marketplace](#marketplace) or directly install from the [Update Site](#update-site)
7+
## Users: If you just want to use Bndtools for your own projects
78

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>
9+
- via the [Eclipse Marketplace](#marketplace)
10+
- or directly install into Eclipse from the [Update Site](#update-site)
911

10-
To get then started with the [bndtools Workspace model](workspace.html), you can follow some videos that can get you started.
12+
## Developers: If you want to contribute to bndtools
1113

12-
## Enhancements
14+
- Setup source code into your existing Eclipse installation. See our [Bndtools Developer Guide](/development.html)
1315

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.
16+
<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>
1517

16-
For more complete information on the changes in the Bndtools release, see <https://github.com/bndtools/bnd/wiki#release-notes>.
18+
To get then started with the [bndtools Workspace model](workspace.html), you can follow some videos that can get you started.
1719

18-
## Known Issues
1920

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-
```
2621
## Marketplace
2722

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

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>
25+
<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">
26+
<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" />
27+
</a>
3128

3229
## Update Site
3330

3431
* From the Help menu select `Install New Software...`
3532
* 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
33+
* In the Name field enter `Bndtools`. In the Location field enter one of the the following P2 Repository URLs
3734

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 |
35+
| Type |URL |alt. URL|
36+
|----------------------------|-------------------------------------------------------|--|
37+
| Latest stable release | `https://bndtools.org/bndtools.p2.repo/7.0.0/` | via [jfrog](https://bndtools.jfrog.io/bndtools/update-latest) |
38+
| Latest release candidate | `https://bndtools.jfrog.io/bndtools/update-rc` ||
39+
| Latest build snapshot | `https://bndtools.jfrog.io/bndtools/update-snapshot` ||
4340

4441
* Press `Next` and then `Finish`, acknowledging the licenses
4542

43+
44+
## Getting Started
45+
46+
To get started with Bnd/Bndtools we recommend:
47+
- the [Concepts](concepts.html) behind bndtools
48+
- our [Video Tour](/workspace.html)
49+
- our [Tutorial](tutorial.html) building a sample application
50+
- and our [Project Templates](/manual/templates.html)
51+
52+
## Release Notes
53+
54+
For more complete information on the changes in the Bndtools release, see <https://github.com/bndtools/bnd/wiki#release-notes>.
55+
56+
57+
## Known Issues
58+
59+
* Bndtools is built to run on Eclipse 2020-06 or later. So Bndtools 7.0.0 may not run on older versions of Eclipse.
60+
61+
* 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
62+
```
63+
-runpath \
64+
biz.aQute.launcher;version="[6.4.0,7)", \
65+
biz.aQute.tester.junit-platform;version="[6.4.0,7)"
66+
```

0 commit comments

Comments
 (0)