You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by ad...@apache.org on 2022/01/28 21:32:24 UTC
[wicket] branch master updated: Some minor corrections and updates of the README file (#494)
This is an automated email from the ASF dual-hosted git repository.
adelbene pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/wicket.git
The following commit(s) were added to refs/heads/master by this push:
new 44c509b Some minor corrections and updates of the README file (#494)
44c509b is described below
commit 44c509b00e2fb6d91487fae185d2e7c9a21e23bd
Author: Daniel Bartl <63...@users.noreply.github.com>
AuthorDate: Fri Jan 28 22:29:50 2022 +0100
Some minor corrections and updates of the README file (#494)
---
README.md | 79 +++++++++++++++++++++++++++++++--------------------------------
1 file changed, 39 insertions(+), 40 deletions(-)
diff --git a/README.md b/README.md
index 11abcfa..3dfe5d5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
<p align="center">
- <a href="http://wicket.apache.org">
- <img height="300" src="https://wicket.apache.org/img/wicket-9-sun.png">
+ <a href="https://wicket.apache.org">
+ <img height="300" src="https://wicket.apache.org/img/wicket-9-sun.png" alt="Wicket version header image">
</a>
</p>
@@ -13,7 +13,7 @@ refreshing lack of XML, Apache Wicket makes developing web-apps simple and
enjoyable again. Swap the boilerplate, complex debugging and brittle code for
powerful, reusable components written with plain Java and HTML.
-Apache Wicket can be found at: http://wicket.apache.org and is licensed under
+Apache Wicket can be found at https://wicket.apache.org and is licensed under
the Apache Software Foundation license, version 2.0.
Getting started
@@ -24,33 +24,33 @@ from, and get started quickly:
- The Wicket user guide - https://wicket.apache.org/learn/#guide:
- learn Wicket from scratch reading its userguide which gradually
+ learn Wicket from scratch reading its user guide which gradually
introduces you to the various features of the framework with
many real-world examples.
- The Wicket JavaDoc:
the API Docs are available on the main site of the project:
- http://wicket.apache.org/learn/#javadoc
+ https://wicket.apache.org/learn/#javadoc
- Wicket Examples:
shows all components in short usage examples, also available live on:
- http://examples9x.wicket.apache.org
+ https://examples9x.wicket.apache.org
- - Wicket Quickstart - http://wicket.apache.org/start/quickstart.html:
+ - Wicket Quickstart - https://wicket.apache.org/start/quickstart.html:
provides a skeleton project for use in NetBeans, Eclipse, IntelliJ IDEA
and other major IDE's, without having to configure anything yourself. Just
copy'n'paste the generated command line and Maven will do the job.
-What is in this package
+What does Wicket's download package contain?
-----------------------
-The archive you just downloaded and unpacked contains the source code and the
-jars of the core projects of Wicket. If you are just starting out, you probably
-only need to include wicket-util-x.jar, wicket-request-x.jar and
+You can download Wicket's source package here: https://wicket.apache.org/start/wicket-9.x.html .
+It contains the source code and the jars of the core projects of Wicket.
+If you are just starting out, you probably only need to include wicket-util-x.jar, wicket-request-x.jar and
wicket-core-x.jar, where x stands for the version. As a rule, use just the jars
you need.
@@ -88,9 +88,9 @@ You will find the source code here:
`-- wicket-velocity
-Here is a list of projects in this distribution and what they do.
+Here is a list of projects in the distribution and what they do.
- - wicket: the core project, includes the framework and basic components;
+ - wicket-core: the core project, includes the framework and basic components;
- wicket-extensions: contains utilities and more specialized components;
- wicket-auth-roles: a basic authorization package based on roles;
- wicket-jmx: registers JMX beans for managing things like your Wicket
@@ -106,14 +106,13 @@ Here is a list of projects in this distribution and what they do.
templates using Wicket components - most people probably don't need this,
but it can be neat when you want to do CMS-like things;
- wicket-examples: contains a basic component reference and many examples of
- how to use Wicket and Wicket components, including examples for sub
- projects such as wicket-spring, wicket-velocity and wicket-auth-roles.
+ how to use Wicket and Wicket components, including examples for subprojects
+ such as wicket-spring, wicket-velocity and wicket-auth-roles.
- wicket-devutils: provides small utilities which can help in development
- phase
+ phase and during debugging
- wicket-bean-validation: validates beans with annotation based on
javax.validation;
- wicket-cdi: the context and dependency injection of the jee standard for wicket;
- - wicket-devutils: some utils to help debugging wicket;
- wicket-experimental: experimental implementations for wicket;
- wicket-native-websocket: wicket's native web sockets integration
for several servers;
@@ -130,27 +129,27 @@ Dependencies
------------
The easiest way of getting the dependencies of your Wicket based projects
-right is to use Apache Maven (http://maven.apache.org) with your projects and
-include the wicket dependencies you want is outlined in the wicket-quickstart.
+right is to use Apache Maven (https://maven.apache.org) with your projects and
+include the wicket dependencies you want as outlined in the wicket-quickstart.
Maven will then take care of including the appropriate dependencies.
-If you do not want to use maven, here is a break down of the dependencies you
+If you do not want to use Maven, here is a break-down of the dependencies you
need. For the complete and precise reference see the wicket-parent pom.xml in
-the src/ folder.
+the root folder.
- wicket and wicket-extensions:
You only need to include the Servlet API (3.1, just for compiling), SLF4J
API and the SLF4J logging implementation you want. You cannot use Wicket
without adding a SLF4J logging implementation to your classpath.
- Please see the SLF4J site (http://www.slf4j.org/) for more information.
+ Please see the SLF4J site (https://www.slf4j.org/) for more information.
- As the following projects all depend on wicket, they inherit these
+ As the following projects all depend on Wicket, they inherit these
dependencies.
- wicket-velocity:
- Apache Velocity 1.7 (http://velocity.apache.org/) and it's dependencies
+ Apache Velocity 1.7 (https://velocity.apache.org/) and it's dependencies
(it ships a velocity-deps jar for convenience)
- wicket-ioc:
@@ -160,7 +159,7 @@ the src/ folder.
- wicket-spring:
- wicket-ioc and Spring (http://www.springframework.org/) and it's
+ wicket-ioc and Spring (https://spring.io/projects/spring-framework/) and it's
dependencies
- wicket-guice:
@@ -169,7 +168,7 @@ the src/ folder.
- wicket-cdi:
Component Dependency Injection 2.0
- (http://cdi-spec.org/)
+ (https://cdi-spec.org/)
- wicket-examples:
@@ -178,28 +177,28 @@ the src/ folder.
Building Wicket from source
---------------------------
-The Wicket distribution contains the final Wicket jar. You can use this
-directly in your applications. The Wicket project also uploads the source
-and JavaDoc jars as well as the final jar to the Maven repository used by
-the Maven build tool. So there is actually no specific need to build Wicket
-yourself from the distribution.
+Wicket's source distribution (download package mentioned above) contains
+also the binaries (jar files) for each of its modules (subprojects).
+You can use these directly in your applications. The Wicket project uploads
+the source and JavaDoc jars to the Maven repository used by the Maven build
+tool as well. So there is actually no specific need to build Wicket yourself
+from the distribution.
-Building using Maven 2 or 3, change the working directory to src and either
-do:
+When building using Maven 2 or 3, execute one of the following in the root folder:
- mvn package
- creates wicket-x.y.z.jar in target/ subdirectory.
+ creates wicket-(subproject)-x.y.z.jar(s) in according target subdirectories.
- mvn install
- creates wicket-x.y.z.jar in target/ subdirectory and installs the file
- into your local Maven repository for use in other projects.
+ creates wicket-(subproject)-x.y.z.jar(s) in according target subdirectories and
+ installs the jar files into your local Maven repository for use in other projects.
Migrating from 8.x
------------------
-This file is a copy of the migration guide from available on our Wiki:
+This file is a copy of the migration guide available on our Wiki:
https://cwiki.apache.org/confluence/display/WICKET/Migration+to+Wicket+9.0
@@ -207,14 +206,14 @@ Getting help
------------
- Read the online documentation available on our website
- (http://wicket.apache.org)
+ (https://wicket.apache.org)
- - Read the migration guide (migration-to-wicket-60.html)
+ - Read the migration guide above
- Read the mailing archives available on Nabble, GMane and Apache
- Send a complete message containing your problem, stacktrace and problem
- you're trying to solve to the user list (users@wicket.apache.org)
+ you're trying to solve to our user list (users@wicket.apache.org)
- Ask a question on IRC at freenode.net, channel ##wicket