You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This repository is an out-of-the-box development environment for Gephi plugins.
6
6
7
7
### Requirements
8
8
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).
10
10
11
11
### Create a plugin
12
12
@@ -70,16 +70,14 @@ Submitting a Gephi plugin for approval is a simple process based on GitHub's [pu
70
70
71
71
- Navigate to your fork's URL and create a pull request. Select `master-forge` instead of `master` as base branch.
72
72
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.
74
74
75
75
## Update a plugin
76
76
77
77
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.
78
78
79
79
## IDE Support
80
80
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
-
83
81
### Netbeans IDE
84
82
85
83
- 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.
115
113
116
114
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.
117
115
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.
119
117
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.
121
119
122
120
#### How are the manifest settings defined?
123
121
@@ -141,7 +139,7 @@ This applies for suite plugins with multiple modules. Besides creating the modul
141
139
142
140
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.
143
141
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`.
145
143
146
144
```
147
145
<dependencies>
@@ -170,7 +168,7 @@ Public packages are configured in the module's `pom.xml` file. Edit the `<public
170
168
171
169
#### What is the difference between plugin and module?
172
170
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.
174
172
175
173
#### When running the plugin in Netbeans I get an error "Running standalone modules or suites requires..."
0 commit comments