Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updated README content #977

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
reinhapa merged 1 commit into from
Oct 4, 2024
Merged

Updated README content #977

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
56 changes: 29 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Apache License 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](http://www.apache.org/licenses/LICENSE-2.0)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.codehaus.izpack/izpack-core/badge.svg)](https://search.maven.org/search?q=g:org.codehaus.izpack)
[![Java 8](https://img.shields.io/badge/java-8-blue.svg)](https://adoptium.net/)
[![javadoc](https://javadoc.io/badge2/org.codehaus.izpack/izpack-api/javadoc.svg)](https://javadoc.io/doc/org.codehaus.izpack/izpack-api)

[IzPack](http://izpack.org/) is a widely used tool for packaging applications on the Java platform as cross-platform installers.

Expand All @@ -15,7 +16,8 @@ under different terms.

## Building IzPack from source

IzPack requires Java SE 1.8 and at minimum Maven 3. Due to the JDK compatibility the maximum Maven version supported is 3.6.3 when compiled using JDK 1.8.
IzPack requires Java SE 1.8 and at minimum Maven 3. Due to the JDK compatibility,
the maximum Maven version supported is 3.6.3 when compiled using JDK 1.8.

mvn verify install

Expand All @@ -29,40 +31,40 @@ While reporting an issue [on our JIRA tracker](https://izpack.atlassian.net/) is

We suggest that [you follow our guidelines for contributing](http://izpack.org/developers/), and especially that you have a fork of [https://github.com/izpack/izpack](https://github.com/izpack/izpack) on GitHub. You can then offer contributions using pull requests.

We very much prefer pull requests over attaching patches in a JIRA issues.
We very much prefer pull requests over attaching patches in JIRA issues.

## Resources

During the migration from the Codehaus services, which were shut down, we had do divide different services to separate providers, there hasn't been available a compact offer comparable to the services the Codehaus in such a short time. There are some smaller drawbacks which couldn't be avoided, see below.
During the migration from the Codehaus services, which were shut down, we had done divide different services to separate providers, there hasn't been available a compact offer comparable to the services the Codehaus in such a short time. There are some smaller drawbacks that couldn't be avoided, see below.

If you are wondering where to find some service the project offers visit out web site http://izpack.org/.
This domain is still kindly provided and paid by Julien Ponge, the project founder.
If you are wondering where to find some service the project offers, visit the website http://izpack.org/.

The most recent snapshots builds based on the `master` branch are available on the Soantype Server:
The most recent snapshots builds based on the `master` branch are available on the Sonatype Server:

[https://oss.sonatype.org/content/repositories/snapshots/org/codehaus/izpack/](https://oss.sonatype.org/content/repositories/snapshots/org/codehaus/izpack/)

Below I provide a list of new services divided by providers:
Below, we provide a list of new services divided by providers:

### IzPack@Github

If you want to participate in development or improving our website, grab a Github account and send pull requests. All you need is the basic idea and the knowledge in using GIT and the Github services.
If you want to participate in development or improving our website, grab a GitHub account and send pull requests. All you need is the basic idea and the knowledge in using GIT and the GitHub services.

Don't use the Github issue tracker or Wiki at this time. We use more advanced services for this.
Don't use the GitHub issue tracker or Wiki at this time. We use more advanced services for this.

#### Source code

The IzPack source code is hosted at https://github.com/izpack/izpack.
See the Developing and contributing section about how to contribute code changes.

Fork the Github repository, create a branch using an according JIRA issue as the branch name for each change and send pull requests from this branch to be able to create a changelog for each release and not get mixed up changes from your master branch for several issues at once.
Fork the GitHub repository, create a branch using an according JIRA issue as the branch name for each change and send pull requests from this branch to be able to create a changelog for each release and not get mixed-up changes from your `master` branch for several issues at once.

#### Web page

The IzPack website is hosted at https://github.com/izpack/izpack.github.com.
For bigger changes or refactory use a special branch for each change. Send pull requests.
The IzPack website is hosted at https://github.com/izpack/izpack.github.io.
For bigger changes or refactorings use a special branch for each change.
Send pull requests.

The resulting website izpack.github.com is directly forwarded to izpack.org by an according DNS configuration.
The resulting website https://izpack.github.io is directly forwarded to izpack.org by according DNS configuration.

### IzPack@Sonatype

Expand All @@ -73,37 +75,37 @@ See our wiki page Deploying IzPack for more information how this is set up and u

### IzPack@Atlassian

We have been set up a new JIRA and Confluence cloud instance kindly provided by Atlassian we received an on-demand open source license for. The central address is https://izpack.atlassian.net/.
We have set up a new JIRA and Confluence cloud instance kindly provided by Atlassian we received an on-demand open source license for. The central address is https://izpack.atlassian.net/.

Although the number of registered users is limited everyone is currently allowed to sign up.
Although the number of registered users is limited, everyone is currently allowed to sign up.

Important |
--------- |
There is a drawback after importing the legacy issues from Codehaus JIRA: There are the same user accounts used for JIRA and Confluence, each of both can be enabled separately for each user. The former users have been recreated along with the issues they participated in, but just their synonyms. There are auto-generated user names and the mail addresses got lost. If you have been alread signed up to Codehaus, before signing up again try to find your user name in some older issues and ask by mail to (re)set your user name and mail address. Please tell me the full name shown in the issues, your current e-mail address and at least one Codehaus JIRA issue you participated in for security reasons. This will save work of moving references to issues and cleaning up duplicate user accounts. After that you will be probably able to reset the password of this migrated account and log in again. If you feel this is a problem for you just sign up straight away and from time to time I will try to clean up the user accounts manually. Former Confluence-only users must re-register in each case. |
| Important |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| There is a drawback after importing the legacy issues from Codehaus JIRA: There are the same user accounts used for JIRA and Confluence, each of both can be enabled separately for each user. The former users have been recreated along with the issues they participated in, but just their synonyms. There are auto-generated user names and the mail addresses got lost. If you have been already signed up to Codehaus, before signing up again try to find your user name in some older issues and ask by mail to (re)set your user name and mail address. Please tell me the full name shown in the issues, your current e-mail address and at least one Codehaus JIRA issue you participated in for security reasons. This will save work of moving references to issues and cleaning up duplicate user accounts. After that you will be probably able to reset the password of this migrated account and log in again. If you feel this is a problem for you just sign up straight away and from time to time I will try to clean up the user accounts manually. Former Confluence-only users must re-register in each case. |

You can sign up to JIRA and Confluence with one and the same user account. It is your choice which one of both services you want use.
You can sign up to JIRA and Confluence with one and the same user account. It is your choice which one of both services you want to use.

#### Issue tracker - JIRA

IzPack issues will continue to be tracked to JIRA. The central address is https://izpack.atlassian.net/.

By the way, the former Codehaus administrators kindly offered a HTTP redirection from the old Codehaus issues to the new address at Codehaus itself in case there are still old links. This has been activated for all former IZPACK issues and their issues IDs have been kept.
By the way, the former Codehaus administrators kindly offered an HTTP redirection from the old Codehaus issues to the new address at Codehaus itself in case there are still old links. This has been activated for all former IZPACK issues and their issues IDs have been kept.

The Github issue tracking has been deactivated to not confuse anyone and because it is just too plain at the moment. There is no real advantage for us at the moment in using Github issues.
The GitHub issue tracking has been deactivated to not confuse anyone and because it is just too plain at the moment. There is no real advantage for us at the moment in using GitHub issues.

#### Confluence - Wiki

The IzPack Wiki has been reimported and left on Confluence. It seems to be the more comfortable choice and better user experience compared to the Github Wiki at the moment.
The IzPack Wiki has been reimported and left on Confluence. It seems to be the more comfortable choice and better user experience compared to the GitHub Wiki at the moment.

The central entry point to IzPack Confluence is at https://izpack.atlassian.net/wiki, or check the [IzPack documentation](https://izpack.atlassian.net/wiki/display/IZPACK/) directly. The content is considered to be up to date for Izpack 5, feel free to help us directly improving the documentation.
The central entry point to IzPack Confluence is at https://izpack.atlassian.net/wiki, or check the [IzPack documentation](https://izpack.atlassian.net/wiki/display/IZPACK/) directly. The content is considered to be up-to-date with Izpack 5, feel free to help us directly by improving the documentation.

### IzPack@Google

#### Google Groups - mailing lists

Regarding the mailing lists we ended up in reusing the existing mailing lists at Google Groups. There is a main reason - we kept all the old messages and subscribers from the Codehaus mailing lists mirrored there automatically and can continue to use it slightly.
Regarding the mailing lists, we ended up reusing the existing mailing lists at Google Groups. There is a main reason—we kept all the old messages and subscribers from the Codehaus mailing lists mirrored there automatically and can continue to use it slightly.

Please note in advance that these are real mailing lists and you do not need necessarily an Google account at all to join them, see [this support notice](https://support.google.com/groups/answer/46438).
Please note in advance that these are real mailing lists, and you do not necessarily need to have a Google account at all to join them, see [this support notice](https://support.google.com/groups/answer/46438).

The existing subscribers have been left and don't probably have to re-subscribe. All existing lists have been left, just the mail addresses change.

Expand All @@ -124,10 +126,10 @@ Do no longer use the former list [email protected]~~!<br>
If you are not a member you can subscribe by sending an e-mail to:
[[email protected]](mailto:[email protected]).

If you are not a member of one of the above groups of your interest you may subscribe to them with or without being logged on as Google user on the web interface or by mail. For more help on Google Groups [visit the according help center](https://support.google.com/groups).
If you are not a member of one of the above groups of your interest, you may subscribe to them with or without being logged on as Google user on the web interface or by mail. For more help on Google Groups [visit the according help center](https://support.google.com/groups).

Be invited to join us again.

### IzPack@Twitter

IzPack has a [Twitter account](https://twitter.com/izpack). We will forward blog posts there and it is open for your tweets for registered Twitter users. Or just follow us to get the latest news.
IzPack has a [Twitter account](https://twitter.com/izpack). We will forward blog posts there, and it is open for your tweets for registered Twitter users. Or just follow us to get the latest news.