Skip to content

Commit

Permalink
Copy documentation from wiki to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
charphi committed Jul 16, 2024
1 parent 59f01c6 commit 8139297
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 2 deletions.
57 changes: 55 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Download](https://img.shields.io/github/release/nbbrd/beanzooka.svg)](https://github.com/nbbrd/beanzooka/releases/latest)
[![Changes](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnbbrd%2Fbeanzooka%2Fbadges%2Funreleased-changes.json)](https://github.com/nbbrd/beanzooka/blob/develop/CHANGELOG.md)

![logo](https://github.com/nbbrd/beanzooka/wiki/assets/logo.png)
![logo](src/main/resources/beanzooka/beanzooka.png)

Beanzooka is a tool that allows to launch several sessions of a NetBeans Platform application at the same time. Each session may have its own configuration such as the user dir, the Java runtime and the active plugins.

Expand All @@ -14,4 +14,57 @@ By launching several sessions of an application, you might be able to:
- check application behavior on different JDKs
- design repeatable scenarios useful for tests, documentation and presentations

See [documentation](https://github.com/nbbrd/beanzooka/wiki).
## Installing
This application requires Java 8 or later to run.
There is no installation; you just need to download the [latest version](https://github.com/nbbrd/beanzooka/releases/latest) (`*-bin.jar`) and put it somewhere on your computer.
Type `javaw -jar ...-bin.jar` to run it.

## How to use

In order to launch a session, you need to specify a few resources. These resources are defined through the user interface and can be stored in an XML file for future use.

The current types of resources are:

| Name | Description |
|---------------|---------------------------------------------------------------------------------|
| `Application` | the path to a NetBeans Platform executable |
| `JDK` | the path to a JDK home and an optional list of parameters |
| `User dir` | the path to a user dir; note that this folder can be temporary, fixed or cloned |
| `Plugins` | a list of plugins to load alongside the application |

To define a resource, right-click on the item you want to define and select `Edit`.

Once the resources are defined, you can launch a session by selecting an application, a JDK and a user dir (plugins are optional) and then by clicking on the launch icon (`F5`).

![screenshot](assets/main_window.png)

All sessions (both running and stopped) are displayed at the bottom of the window. Their user dir and log files can be accessed by using the context menu. Note that temporary directories are deleted when Beanzooka is closed.

## Automation

It is possible to launch Beanzooka with pre-loaded resources by using the command line.
For example: `beanzooka.exe D:\some_resources.xml`

## Developing

This project is written in Java and uses [Apache Maven](https://maven.apache.org/) as a build tool.
It requires [Java 8 as minimum version](https://whichjdk.com/) and all its dependencies are hosted on [Maven Central](https://search.maven.org/).

The code can be build using any IDE or by just type-in the following commands in a terminal:

```shell
git clone https://github.com/nbbrd/beanzooka.git
cd beanzooka
mvn clean install
```

## Contributing

Any contribution is welcome and should be done through pull requests and/or issues.

## Licensing

The code of this project is licensed under the [European Union Public Licence (EUPL)](https://joinup.ec.europa.eu/page/eupl-text-11-12).

## Credits
Logo designed by [Jeremy Demortier](https://github.com/CyLuGh)
Binary file added assets/main_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8139297

Please sign in to comment.