From a69804f84dbd1c18c2d85104a9ff023fe02226f1 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Fri, 1 Aug 2014 14:31:19 -0400 Subject: [PATCH] updated documentation Former-commit-id: e8b6c86e47cff66f72ffb53ccba4bef18479b43e --- .../src/site/markdown/installation.md.vm | 15 ++++++++++++++- .../src/site/markdown/{usage.md => usage.md.vm} | 10 +++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) rename dependency-check-ant/src/site/markdown/{usage.md => usage.md.vm} (67%) diff --git a/dependency-check-ant/src/site/markdown/installation.md.vm b/dependency-check-ant/src/site/markdown/installation.md.vm index f45edf1f2..a49cd6568 100644 --- a/dependency-check-ant/src/site/markdown/installation.md.vm +++ b/dependency-check-ant/src/site/markdown/installation.md.vm @@ -3,7 +3,20 @@ Installation Download dependency-check-ant from [bintray here](http://dl.bintray.com/jeremy-long/owasp/dependency-check-ant-${project.version}.jar). To install dependency-check-ant place the dependency-check-ant-${project.version}.jar into the lib directory of your Ant instalation directory. Once installed you can add -the taskdef to you build.xml and add the task to a new or existing target. +the taskdef to you build.xml and add the task to a new or existing target: + +```xml + +``` + +If you do not want to install dependency-check-ant into your ant's lib directory when you define the task def you +must add the classpath to the taskdef: + +```xml + + + +``` It is important to understand that the first time this task is executed it may take 20 minutes or more as it downloads and processes the data from the National diff --git a/dependency-check-ant/src/site/markdown/usage.md b/dependency-check-ant/src/site/markdown/usage.md.vm similarity index 67% rename from dependency-check-ant/src/site/markdown/usage.md rename to dependency-check-ant/src/site/markdown/usage.md.vm index 7968b772a..49a4b8624 100644 --- a/dependency-check-ant/src/site/markdown/usage.md +++ b/dependency-check-ant/src/site/markdown/usage.md.vm @@ -1,11 +1,19 @@ Usage ==================== -First, add the dependency-check-ant taskdef to your build.xml: +First, add the dependency-check-ant taskdef to your build.xml (see the [installation guide](installation.html): ```xml ``` +Or + +```xml + + + +``` + Next, add the task to a target of your choosing: ```xml