Skip to content

Commit 2ab18b5

Browse files
authored
Update README [ci skip]
1 parent 8f17082 commit 2ab18b5

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repository is an out-of-the-box development environment for Gephi plugins.
66

77
### Requirements
88

9-
Developing Gephi plugins requires JDK 11 or later and [Maven](http://maven.apache.org/).
9+
Developing Gephi plugins requires JDK 8 or later and [Maven](http://maven.apache.org/). Although any IDE/Editor can be used, [Netbeans IDE](https://netbeans.org/) is recommended as Gephi itself is based on [Netbeans Platform](https://netbeans.org/features/platform/index.html).
1010

1111
### Create a plugin
1212

@@ -70,16 +70,14 @@ Submitting a Gephi plugin for approval is a simple process based on GitHub's [pu
7070

7171
- Navigate to your fork's URL and create a pull request. Select `master-forge` instead of `master` as base branch.
7272

73-
- Submit your pull request. If possible, before you submit make sure to [enable edits from maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so that we can help you tweak the code and configuration when needed.
73+
- Submit your pull request.
7474

7575
## Update a plugin
7676

7777
Updating a Gephi plugin has the same process as submitting it for the first time. Don't forget to merge from upstream's master branch.
7878

7979
## IDE Support
8080

81-
Although any IDE/Editor can be used, [Netbeans IDE](https://netbeans.org/) is recommended as Gephi itself is based on [Netbeans Platform](https://netbeans.org/features/platform/index.html).
82-
8381
### Netbeans IDE
8482

8583
- Start Netbeans and go to `File` and then `Open Project`. Navigate to your fork repository, Netbeans automatically recognizes it as Maven project.
@@ -115,9 +113,9 @@ Yes, native libraries can be used in modules.
115113

116114
The `modules` folder is where plugin modules go. Each plugin is defined in a single folder in this directory. A plugin can be composed of multiple modules (it's called a suite then) but usually one is enough to do what you want.
117115

118-
The `pom.xml` file in `modules` is the parent pom for plugins. A Maven pom can inherit configurations from a parent and that is something we use to keep each plugin's pom very simple. Notice that each plugin's pom (i.e. the `pom.xml` file in the plugin folder) has a `<parent>` defined.
116+
A Maven pom can inherit configurations from a parent and that is something we use to keep each plugin's pom very simple. Notice that each plugin's pom (i.e. the `pom.xml` file in the plugin folder) has a `<parent>` defined.
119117

120-
The `pom.xml` file at the root folder makes everything fit together and notably lists the modules.
118+
The `pom.xml` file at the root folder makes everything fit together and notably lists the modules. No need to change anything there besises this list.
121119

122120
#### How are the manifest settings defined?
123121

@@ -141,7 +139,7 @@ This applies for suite plugins with multiple modules. Besides creating the modul
141139

142140
Dependencies are configured in the `<dependencies>` section in the plugin folder's `pom.xml`. Each dependency has a `groupId`, an `artifactId` and a `version`. There are three types of dependencies a plugin can have: an external library, a Gephi module or a Netbeans module.
143141

144-
The list of Gephi and Netbeans dependencies one can use can be found in the `modules/pom.xml` file. All possible dependencies are listed in the `<dependencyManagement>` section. Because each plugin module inherits from this parent pom the version can be omitted when the dependency is set. For instance, this is how a plugin depends on `GraphAPI` and Netbeans's `Lookup`.
142+
The list of Gephi and Netbeans dependencies one can use can be found in the parent POM, which you can browse [here](https://github.com/gephi/gephi-plugins/blob/6136ba8427349aa16c4f4b94265267fc3de0e767/modules/pom.xml#L76). All possible dependencies are listed in the `<dependencyManagement>` section. Because each plugin module already inherits the version from this parent pom, it can be omitted. For instance, this is how a plugin depends on `GraphAPI` and Netbeans's `Lookup`.
145143

146144
```
147145
<dependencies>
@@ -170,7 +168,7 @@ Public packages are configured in the module's `pom.xml` file. Edit the `<public
170168

171169
#### What is the difference between plugin and module?
172170

173-
It's the same thing. We say module because Gephi is a modular application and is composed of many independent modules. Plugins also are modules, but we call them plugin because they aren't in the _core_ Gephi.
171+
It's the same thing. We say module because Gephi is a modular application and is composed of many independent modules. Plugins also are modules but we call them plugin because they aren't in the _core_ Gephi.
174172

175173
#### When running the plugin in Netbeans I get an error "Running standalone modules or suites requires..."
176174

0 commit comments

Comments
 (0)