Skip to content

readme update #5126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbien merged 1 commit into from
Jan 6, 2023
Merged

readme update #5126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ Apache NetBeans is an open source development environment, tooling platform, and
* GitHub actions
* [![Build Status](https://github.com/apache/netbeans/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/apache/netbeans/actions/workflows/main.yml)
* [![Profiler Lib Native Binaries](https://github.com/apache/netbeans/actions/workflows/native-binary-build-lib.profiler.yml/badge.svg?branch=master)](https://github.com/apache/netbeans/actions/workflows/native-binary-build-lib.profiler.yml)
* TravisCI:
* [![Build Status](https://app.travis-ci.com/apache/netbeans.svg?branch=master)](https://app.travis-ci.com/apache/netbeans)
* Apache Jenkins:
* Linux: [![Build Status](https://ci-builds.apache.org/job/Netbeans/job/netbeans-linux/badge/icon)](https://ci-builds.apache.org/job/Netbeans/job/netbeans-linux/)
* Windows: [![Build Status](https://ci-builds.apache.org/job/Netbeans/job/netbeans-windows/badge/icon)](https://ci-builds.apache.org/job/Netbeans/job/netbeans-windows)
Expand All @@ -54,21 +52,26 @@ Build with the default config (See the [cluster.config](https://github.com/apach
```
$ ant
```
Build the basic project (mainly, JavaSE features):
Build the basic project (mainly Java features):
```
$ ant -Dcluster.config=basic
```
Build the full project (including Groovy, PHP, JavaEE/JakartaEE, and JavaScript features):
Build the full project (including Groovy, PHP, JavaEE/JakartaEE and JavaScript features):
```
$ ant -Dcluster.config=full
```
Build the NetBeans Platform:
```
$ ant -Dcluster.config=platform
```
Cleanup:
```
$ ant -q clean
Copy link
Contributor

@lkishalmi lkishalmi Dec 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also mention git clean -xdf which sometimes provides faster and "cleaner" result.

Copy link
Member Author

@mbien mbien Dec 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i thought about this. But this is more of a git trick and has not much to do with the NetBeans project IMO.

If we wanted to support it we should call it from ant, like: ant reset-workspace which would be also self explanatory that it is a quite dangerous ant goal.

git clean is no joke. It cleans your sources and everything else too. ant clean is for the build (assuming it works).

Copy link
Contributor

@ebarboni ebarboni Jan 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a way to clean the external ? I often had the issue of remaining jar file in external that pollute build.

Copy link
Member Author

@mbien mbien Jan 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't think there is a target for that. I added a external clean target for nb-javac (#3392) since this would horribly break the build if it uses wrong jars (lost at least a hour on that trying to find the issue).

But nothing else cleans the ext folder. Would be a good idea though.

```

#### Notes:
* You can also use `php`, `enterprise`, etc. See the [cluster.properties](https://github.com/apache/netbeans/blob/master/nbbuild/cluster.properties) file.
* once built, you can simply open individual modules of interest with NetBeans and run/rebuild/debug them like any other project

#### Generating Javadoc

Expand Down Expand Up @@ -102,7 +105,7 @@ Latest release (convenience binary of released source artifacts): https://netbea

### Reporting Bugs

Bugs should be reported to https://github.com/apache/netbeans/issues
[How to report bugs](https://netbeans.apache.org/participate/report-issue.html)

### Log, Config and Cache Locations

Expand Down