Clean up README files

Resolves: https://jira.duraspace.org/browse/FCREPO-1804
fcrepo · Oct 28, 2015 · be7beb8 · be7beb8
1 parent 8cceaeb
commit be7beb8
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -7,13 +7,48 @@
 [Use cases](https://wiki.duraspace.org/display/FF/Use+Cases) |
 [REST API](https://wiki.duraspace.org/display/FEDORA4x/RESTful+HTTP+API) |
 
-Technical goals:
+Fedora is a robust, modular, open source repository system for the management and dissemination of digital content.
+It is especially suited for digital libraries and archives, both for access and preservation. It is also used to
+provide specialized access to very large and complex digital collections of historic and cultural materials as well
+as scientific data. Fedora has a worldwide installed user base that includes academic and cultural heritage
+organizations, universities, research institutions, university libraries, national libraries, and government agencies.
+The Fedora community is supported by the stewardship of the [DuraSpace](http://www.duraspace.org) organization.
+
+##Technical goals:
 * Improved scalability and performance
 * More flexible storage options
 * Improved reporting and metrics
 * Improved durability
 
-## Building & running fcrepo4 from source
+## Downloads
+
+The current web-deployable version of Fedora can be downloaded from the [Duraspace website](https://wiki.duraspace.org/display/FF/Downloads)
+or from [Github](https://github.com/fcrepo4/fcrepo4/releases). These artifacts can be deployed directly in a Jetty or Tomcat container
+as described in the guide to [deploying Fedora](https://wiki.duraspace.org/display/FEDORA4x/Deploying+Fedora+4+Complete+Guide).
+
+## Contributing
+
+Contributions to the Fedora project are always welcome. These may take the form of testing the application, clarifying documentation
+or writing code.
+
+Code contributions will take the form of pull requests to this repository. They also require a signed
+[contributor license agreement](https://wiki.duraspace.org/display/DSP/Contributor+License+Agreements) on file before
+a pull request can be merged. New developers may wish to review [this guide](https://wiki.duraspace.org/display/FF/Guide+for+New+Developers)
+as it explains both the process and standards for test coverage, style and documentation.
+
+## Getting help
+
+There are two community mailing lists where you can post questions or raise topics for discussion. Everyone is
+welcome to subscribe and participate.
+
+* https://groups.google.com/d/forum/fedora-community
+* https://groups.google.com/d/forum/fedora-tech
+
+Many of the developers are available on the `#fcrepo` IRC channel, hosted by [freenode.net](http://webchat.freenode.net).
+
+In addition, there are weekly [technical calls](https://wiki.duraspace.org/display/FF/Meetings) which anyone may join.
+
+## Building and running Fedora from source
 
 System Requirements
 * Java 8
@@ -23,10 +58,30 @@ System Requirements
 $ git clone https://github.com/fcrepo4/fcrepo4.git
 $ cd fcrepo4
 $ MAVEN_OPTS="-Xmx1024m -XX:MaxMetaspaceSize=1024m" mvn install
+```
+
+The compiled Fedora war file can be found in `./fcrepo-webapp/target`. This can be deployed directly to a servlet container as
+described in the [deployment guide](https://wiki.duraspace.org/display/FEDORA4x/Deploying+Fedora+4+Complete+Guide).
+
+If deployed locally using a war file called `fcrepo.war`, the web application will typically be available at
+http://localhost:8080/fcrepo/rest.
+
+There are two convenient methods for *testing* the Fedora application by launching it directly from the command line.
+
+One option is to use the "one click" application, which comes with an embedded Jetty servlet. This can be started by
+either double-clicking on the jar file or by running the following command:
+
+    java -jar ./fcrepo-webapp/target/fcrepo-webapp-<version>-jetty-console.jar
+
+An alternative is use the maven command: `mvn jetty:run`
+
+```
 $ cd fcrepo-webapp
 $ MAVEN_OPTS="-Xmx512m" mvn jetty:run
 ```
 
+For both of these methods, your Fedora repository will be available at: [http://localhost:8080/rest/](http://localhost:8080/rest/)
+
 Note: You may need to set the $JAVA_HOME property, since Maven uses it to find the Java runtime to use, overriding your PATH.
 `mvn --version` will show which version of Java is being used by Maven, e.g.:
 
@@ -38,7 +93,7 @@ Java home: /usr/local/java-1.8.0_31/jre
 To set your $JAVA_HOME environment variable:
 
 ```bash
-JAVA_HOME=/path/to/java
+export JAVA_HOME=/path/to/java
 ```
 
 If you have problems building fcrepo4 with the above settings, you may need to also pass
@@ -49,5 +104,3 @@ $ MAVEN_OPTS="-Xmx1024m" mvn -Djacoco.agent.it.arg="-XX:MaxMetaspaceSize=1024m -
 ```
 
 
-That's it! Your Fedora repository is up and running at: [http://localhost:8080/rest/](http://localhost:8080/rest/)
-
diff --git a/fcrepo-kernel-modeshape/README.md b/fcrepo-kernel-modeshape/README.md