[Documentation] Change README to be used in binary
authorJonas Pfefferle <pepperjo@apache.org>
Thu, 15 Nov 2018 15:37:23 +0000 (16:37 +0100)
committerJonas Pfefferle <pepperjo@apache.org>
Thu, 15 Nov 2018 15:38:27 +0000 (16:38 +0100)
Adapt README that it can also be used in the binary tarball.

https://jira.apache.org/jira/projects/CRAIL/issues/CRAIL-83

Signed-off-by: Jonas Pfefferle <pepperjo@apache.org>
README.md

index 5a5db9d..c0e86d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,24 +26,26 @@ Apache Crail is a fast multi-tiered distributed storage system designed from gro
 It marks the backbone of the Crail I/O architecture, which is described in more detail on [crail.incubator.apache.org](http://crail.incubator.apache.org). 
 The unique features of Crail include:
 
-* Zero-copy network access from userspace 
+* Zero-copy network access from userspace
 * Integration of multiple storage tiers such DRAM, flash and disaggregated shared storage
 * Ultra-low latencies for both meta data and data operations. For instance: opening, reading and closing a small file residing in the distributed DRAM tier less than 10 microseconds, which is in the same ballpark as some of the fastest RDMA-based key/value stores
 * High-performance sequential read/write operations: For instance: read operations on large files residing in the distributed DRAM tier are typically limited only by the performance of the network
 * Very low CPU consumption: a single core sharing both application and file system client can drive sequential read/write operations at the speed of up to 100Gbps and more
 * Asynchronous API leveraging the asynchronous nature of RDMA-based networking hardware
 * Extensible plugin architecture: new storage tiers tailored to specific hardware can be added easily
-Crail is implemented in Java offering a Java API which integrates directly with the Java off-heap memory. Crail is designed for performance critical temporary data within a scope of a rack or two. 
+
+Crail is implemented in Java offering a Java API which integrates directly with the Java off-heap memory. Crail is designed for performance critical temporary data within a scope of a rack or two.
 
 ## Documentation
 
-The documentation can be accessed by running `make html` in `/doc` and opening `/doc/build/html/index.html` for information about how to deploy, run, test and program against Crail. The latest version of the documentation can be found at https://incubator-crail.readthedocs.org.
+For information about how to deploy, run, test and program against Crail:
+* Refer to https://incubator-crail.readthedocs.org
+* Or build from source by running `make html` in `/doc` and opening `/doc/build/html/index.html`
 
 
-## Community 
+## Community
 
-Please join the Crail developer mailing list for discussions and notifications. The list is at: 
+Please join the Crail developer mailing list for discussions and notifications. The list is at:
 
 dev@crail.incubator.apache.org.