Commits

Christian Schlichtherle committed 0d442bb

Improved web site.

Comments (0)

Files changed (2)

truelicense-maven-archetype/src/site/apt/generating.apt.vm

 
 Generating a Sample Project
 
-    To generate a sample project, type the following command in a shell,
-    thereby customizing the property values to meet your requirements:
+    To generate a sample project, copy-paste the following command into a shell
+    - without the leading dollar sign.
+    Before you press the Enter key, please customize the property values to
+    meet your requirements:
 
 +--
 $ mvn archetype:generate \
     -DarchetypeArtifactId=${project.artifactId} \
     -DarchetypeVersion=${project.version} \
     -DgroupId=com.company \
-    -DartifactId=sample \
+    -DartifactId=product \
     -Dversion=0.1-SNAPSHOT \
-    -Dpackage=com.company
+    -Dpackage=com.company \
+    -Dsubject="Product 1"
 +--
 
-    The following table explains all available properties:
+    The following table explains the customizable properties:
 
 *--+--+--+
-||Name||Description||Default Value||
+|| Name || Default Value || Description
 *--+--+--+
-|<<<groupId>>>|n/a|The group ID of the generated project.
+|<<<groupId>>> | n/a | The group ID of the generated project. This could be the reversed domain name for your company - see below.
 *--+--+--+
-|<<<artifactId>>>|n/a|The artifact ID of the parent POM of the generated project.
+|<<<artifactId>>> | n/a | The artifact ID of the parent POM for the generated project. This could be your product name. Whatever it is, it should be converted to lowercase - see below.
 *--+--+--+
-|<<<version>>>|n/a|The version of the generated project.
+|<<<version>>> | n/a | The version of the generated project. This could be your product version. Please specify at most two dots and append "-SNAPSHOT" to it - see below.
 *--+--+--+
-|<<<package>>>|n/a|The base package name of the generated project.
+|<<<package>>> | n/a | The base package name of the generated project. This should be the same as the group ID if it's a valid package name.
 *--+--+--+
-|<<<truelicense-version>>>|<<<${project.version}>>>|The version of the TrueLicense library. You can change this property by editing the generated parent POM - see {{{./customizing.html}Customizing the Sample Project}}.
+|<<<subject>>> | <<<Product 1>>> | The licensing subject for validation. This should include the name of your product and a version number range. You can change this property by editing the generated licensing schema in the KeyGen and KeyMgr modules - see {{{./customizing.html}Customizing the Sample Project}}.
 *--+--+--+
-|<<<subject>>>|<<<Product 1>>>|The licensing subject for validation. This should include the name of your product and a version number range. You can change this property by editing the generated licensing schema in the KeyGen and KeyMgr modules - see {{{./customizing.html}Customizing the Sample Project}}.
-*--+--+--+
-|<<<secret-ftp-marker-class>>>|<<<sun.security.provider.Sun>>>|The name of the secret class which is used as a marker for checking the consumer's eligibility for a Free Trial Period (FTP). You can change this property or disable the feature by editing the generated licensing schema in the KeyMgr module - see {{{./customizing.html}Customizing the Sample Project}}.
+|<<<secret-ftp-marker-class>>> | <<<sun.security.provider.Sun>>> | The name of the secret class which is used as a marker for checking the license consumer's eligibility for a Free Trial Period (FTP). You can change this property or disable the feature by editing the generated licensing schema in the KeyMgr module - see {{{./customizing.html}Customizing the Sample Project}}.
 *--+--+--+
 
-    Upon successful execution, a new directory with the value of the property
-    <<<artifactId>>> as its name will have been created in the current
-    directory.
+    For explanation of the <<<groupId>>>, <<<artifactId>>> and <<<version>>>
+    properties, please check
+    {{http://maven.apache.org/pom.html#Maven_Coordinates}}.
+
+    Upon successful execution, a new directory with the artifact ID as its name
+    will have been created in the current directory.
     From now on, the absolute path of the generated sample directory gets
     referenced by the expression <<<$SAMPLE>>>.
 

truelicense-maven-archetype/src/test/filtered/projects/basic/archetype.properties

 groupId=com.company
-artifactId=sample
+artifactId=product
 version=0.1-SNAPSHOT
 package=com.company
 truelicense-version=${project.version}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.