fix markup

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@326651 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Jason van Zyl 2005-10-19 19:04:48 +00:00
parent 59dfd7900a
commit d25845da43
4 changed files with 58 additions and 1 deletions

View File

@ -70,7 +70,7 @@ Documentation
* {{{mini/guide-using-extensions.html}Guide to using Extensions}}
* {{{mini/guide-using-modello.htmlt}Guide to using Modello}}
* {{{mini/guide-using-modello.html}Guide to using Modello}}
* {{{mini/guide-webapp.html}Guide to Webapps}}
@ -124,6 +124,12 @@ Documentation
* {{{../developers/mojo-api-specification.html}Mojo API}}
* {{{..//mojo-api-specification.html}Mojo API}}
* {{{../ant-tasks.html}Ant Tasks}}
* {{{../glossary.html}Glossary}}
* {{{../maven-conventions.html}Maven Conventions}}
[]

View File

@ -8,6 +8,13 @@
Introduction to the Standard Directory Layout
Having a common directory layout would allow for users familiar with one Maven project to immediately feel
at home in another Maven project. The advantages are analogous to adopting a site-wide look-and-feel.
The next section documents the directory layout expected by Maven and the directory layout created by
Maven. Please try to conform to this structure as much as possible; however, if you can't these settings can
be overridden via the project descriptor.
*--------------------------+-----------------------------------------------+
| src/main/java | Application/Library sources
*--------------------------+-----------------------------------------------+
@ -27,3 +34,30 @@ Introduction to the Standard Directory Layout
*--------------------------+-----------------------------------------------+
| src/site | Site
*--------------------------+-----------------------------------------------+
| LICENSE.txt | Project's license
*--------------------------+-----------------------------------------------+
| README.txt | Project's readme
*--------------------------+-----------------------------------------------+
At the top level files descriptive of the project: a <<<pom.xml>>> file (and any properties,
<<<maven.xml>>> or <<<build.xml>>> if using Ant). In addition, there are textual documents meant
for the user to be able to read immediately on receiving the source: <<<README.txt>>>,
<<<LICENSE.txt>>>, etc.
There are just two subdirectories of this structure: <<<src>>> and <<<target>>>. The only other
directories that would be expected here are metadata like <<<CVS>>> or <<<.svn>>>, and any
subprojects in a multiproject build (each of which would be laid out as above).
The <<<target>>>directory is used to house all output of the build.
The <<<src>>> directory contains all of the source material for building the project, its site and so on.
It contains a subdirectory for each type: <<<main>>> for the main build artifact, <<<test>>> for
the unit test code and resources, <<<site>>> and so on.
Within artifact producing source directories (ie. <<<main>>> and <<<test>>>), there is one
directory for the language <<<java>>> (under which the normal package hierarchy exists), and one for
<<<resources>>> (the structure under which is copied to the target classpath given the default resource definition).
If there are other contributing sources to the artifact build, they would be under other subdirectories: for
example <<<src/main/antlr>>> would contain Antlr grammar definition files.

View File

@ -0,0 +1,11 @@
------
Guide to uploading artifacts to Ibiblio
------
Jason van Zyl
------
12 October 2005
------
Guide to uploading artifacts to Ibiblio
In progress.

View File

@ -9,6 +9,12 @@
* {{{../developers/mojo-api-specification.html}Mojo API}}
* {{{..//mojo-api-specification.html}Mojo API}}
* {{{../ant-tasks.html}Ant Tasks}}
* {{{../glossary.html}Glossary}}
* {{{../maven-conventions.html}Maven Conventions}}
[]