Adding basic instructions to README, fixing packaging

fcrepo-exts · Jul 29, 2015 · 272d3b2 · 272d3b2
1 parent 9045d42
commit 272d3b2
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8,3 +8,26 @@ Utilities for maintaining the [Fedora Commons repository](http://github.com/fcre
     * fedora:mimeType => ebucore:hasMimeType
     * premis:hasOriginalName => ebucore:filename
 
+Building
+--------
+
+To build the JAR file
+
+``` sh
+mvn package
+```
+
+Running
+-------
+
+To run the migration utility, execute the JAR file and provide the `fcrepo.home` system property to set the directory that contains Fedora 4's `fcrepo4-data` directory.
+
+``` sh
+java -Dfcrepo.home=/path/to/fcrepo.home -jar /path/to/fcrepo4-upgrade-utils/target/fcrepo-upgrade-utils-4.3.1-SNAPSHOT.jar
+```
+
+To run the migration utility in "dry-run" mode where it will output a summary of the migration it would perform, but not actually change the repository: 
+
+``` sh
+java -Dfcrepo.home=/path/to/fcrepo.home -jar /path/to/fcrepo4-upgrade-utils/target/fcrepo-upgrade-utils-4.3.1-SNAPSHOT.jar dryrun
+```
diff --git a/pom.xml b/pom.xml
@@ -12,7 +12,7 @@
   <artifactId>fcrepo-upgrade-utils</artifactId>
   <name>Fedora Repository Utilities</name>
   <description>The Fedora Commons repository upgrade utilities: Provides tools for maintaining the Fedora Commons repository.</description>
-  <packaging>bundle</packaging>
+  <packaging>jar</packaging>
 
   <properties>
     <project_name>fcrepo4-upgrade-utils</project_name>