Merge pull request #143 from buda-base/asset-manager-141

Documentation updates

README.md

@@ -1,24 +1,21 @@
-# asset-manager
+# BDRC Asset Manager
+## Overview
+Asset Manager is a suite of tools and applications developed by the Buddhist Digital Resource Center
+(BDRC) to aid contributors and staff to audit, package, and transmit content to BDRC for publication
 
-## Source code documentation
-This document is intended for developers of audit tool.
-### Audit Tool
-#### Installation and configuration
+## User Documentation
+User Documentation can be found at [Github Asset Manager Pages](https://buda-base.github.io/asset-manager/)
+## Development
+This section applies to developers.
+### Requires:
 
-[Audit Test Shell installation](audittool/audit-test-shell/Install-1.0-alpha.md)
-
-[Operation](audittool/audit-test-shell/AuditToolOperation-1.0-alpha.md)
-
-[Test Library (Google Doc)](https://docs.google.com/document/d/1TrjUdoLJd5N90d1vWloRqNrlC144-DPfLrClOLsbhVg/edit?usp=sharing) This is provisional documentation.
-
-## mkdocs (not maintained)
-### Development
-#### Requires:
 - Java 17 SDK
 - Mkdocs version 1.0.4
 
-#### Build:
-##### docs
+### Build
+#### Code
+Audit tool is a maven project. Although it is open source, BDRC cannot support development by others.
+#### docs
 - clone the repository
 - `$cd  <repository>`
 - `mkdocs serve` to test locally

audittool/audit-test-shell/src/main/java/io/bdrc/audit/shell/ArgParser.java

@@ -62,7 +62,8 @@ class ArgParser {
         {
             cl = clp.parse(options, args);
             isParsed = true;
-            cl.getArgList().stream().forEach(z -> logger.debug("Found arg :{}:",z));
+
+            cl.getArgList().forEach(z -> logger.debug("Found arg :{}:",z));
 
             // nonOptionArgs = RecurseParse(cl.getArgList());
             nonOptionArgs = cl.getArgList() ;
@@ -154,7 +155,8 @@ List<String> getDirs() throws IOException {
             try {
                 fileArgs =
                         Files.readAllLines(Paths.get(argFile), StandardCharsets.UTF_8);
-                fileArgs.replaceAll(x -> x.trim());
+                fileArgs.replaceAll(String::trim);
+
                 returned = new ArrayList<>(fileArgs);
 
 
@@ -183,7 +185,8 @@ List<String> getDirs() throws IOException {
 
     private void printHelp(final Options options) {
         HelpFormatter formatter = new HelpFormatter();
-        formatter.printHelp("audittool [options] { - | Directory,Directory,Directory}\nwhere:\n\t- read " +
+        formatter.printHelp("audit-tool [options] { - | Directory,Directory,Directory}\nwhere:\n\t- read " +
+
                                     "folders from " +
                                     "standard input\n\t" +
                                     "Directory .... is a list of directories separated by whitespace " +

audittool/audit-test-shell/src/main/scripts/jpackage-debian.conf

@@ -1,4 +1,6 @@
-# jpackage-macos
+
+# jpackage-debian
+
 
 # Usage:
 # jpackage @this file
@@ -10,7 +12,8 @@
 # audit-test-shell: mvn clean package
 
 # Part 1 - Application variables. Must be present in all packages
---app-version '1.0'
+--app-version '1.0-alpha'
+
 --copyright 'Copyright 2020-2022, Buddhist Digital Resource Center'
 --description 'Validates image data sets against BDRC standards'
 --name 'audit-tool'
@@ -43,3 +46,6 @@
 #
 # Part 4  - platform specific options
 # --type deb
+--linux-package-name audit-v1
+--linux-app-release 1
+

docs/index.md

@@ -3,10 +3,6 @@
 
 This is the project website for the Buddhist Digital Resource Center Asset Manager project.
 
-The contents of this site are in DRAFT mode: all content is subject to change without notice until this paragraph is removed.
 
-At this writing, the work is primarily in the
-[Requirements][4eeb6e4d] and [Design][b6d006b1] sections.
 
-  [4eeb6e4d]: req/requirements/ "Asset Manager Requirements"
-  [b6d006b1]: design/design/ "Asset Manager Design"
+