You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by sl...@apache.org on 2021/03/17 11:37:40 UTC

[daffodil-site] branch master updated: Add reference to using apache/daffodil-schema.g8

This is an automated email from the ASF dual-hosted git repository.

slawrence pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 19cdb94  Add reference to using apache/daffodil-schema.g8
19cdb94 is described below

commit 19cdb94db5f77e73ee7efac8a9b50500dd6c6f66
Author: Steve Lawrence <sl...@apache.org>
AuthorDate: Fri Feb 26 13:00:06 2021 -0500

    Add reference to using apache/daffodil-schema.g8
---
 site/dfdl-layout.md | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/site/dfdl-layout.md b/site/dfdl-layout.md
index 6c27bde..e6fbcc2 100644
--- a/site/dfdl-layout.md
+++ b/site/dfdl-layout.md
@@ -25,8 +25,24 @@ limitations under the License.
 There is a specific way of organizing a DFDL schema project that has been found
 to be helpful. It uses specific directory naming conventions and tree structure
 to manage name conflicts in a manner similar to how Java package names
-correspond to directory names. This set of conventions provides a number of
-benefits:
+correspond to directory names.
+
+### Quick Start
+
+To quickly get started and generate this directory structure, you can install
+[SBT](https://www.scala-sbt.org/) and run the following command:
+
+```
+sbt new apache/daffodil-schema.g8
+```
+
+This prompts for various properties and creates the directory structure
+described below, including git and sbt configuration files, a basic DFDL schema
+file, and TDML and test files.
+
+### Conventions
+
+This set of conventions provides a number of benefits:
 
 * No name conflicts or ambiguity on classpath if multiple DFDL schemas are used
   together
@@ -49,7 +65,7 @@ These conventions are actually usable for regular XML-schema projects, that is,
 they're not really DFDL-specific conventions. They're general conventions for
 organizing projects so as to achieve the above benefits.
 
-### Conventions
+### Standard File Tree
 
 Let's assume the DFDL schema contains two files named rfmt.dfdl.xsd, and
 format.dfdl.xsd, and that our format is named RFormat (rfmt) with an