Merge branch '11917-dont-clear-cache'

[arvados.git] / README.md

diff --git a/README.md b/README.md
index 2ba181ae82ab7e43d5e5b58699458ab683afdcd2..367c3e8f60c5ccb2bb5f5490c32812ed0bbceca1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-Welcome to Arvados
-==================
+[//]: # Copyright (C) The Arvados Authors. All rights reserved.
+[//]: #
+[//]: # SPDX-License-Identifier: CC-BY-SA-3.0
 
 [Arvados](https://arvados.org) is a free software distributed computing platform
 for bioinformatics, data science, and high throughput analysis of massive data
@@ -10,24 +11,30 @@ Arvados consists of:
 * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and
   storing collections of files, accessible via HTTP and FUSE mount.
 
-* *Crunch*: a Docker-based workflow engine designed providing strong
-  versioning, reproducibilty, and provenance of computations.
+* *Crunch*: a Docker-based cluster and HPC workflow engine designed providing
+  strong versioning, reproducibilty, and provenance of computations.
 
 * Related services and components including a web workbench for managing files
   and compute jobs, REST APIs, SDKs, and other tools.
 
 ## Quick start
 
-To try out Arvados quickly, you can use Arvbox, which provides Arvados
-components pre-installed in a Docker container (requires Docker 1.9+).  After
-cloning the Arvados git repository:
+Curoverse maintains an Arvados public cloud demo at
+[https://cloud.curoverse.com](https://cloud.curoverse.com).  A Google account
+is required to log in.
+
+To try out Arvados on your local workstation, you can use Arvbox, which
+provides Arvados components pre-installed in a Docker container (requires
+Docker 1.9+).  After cloning the Arvados git repository:
 
 ```
 $ cd arvados/tools/arvbox/bin
 $ ./arvbox start localdemo
 ```
 
-See http://doc.arvados.org/install/arvbox.html for details and documentation.
+In this mode you will only be able to connect to Arvbox from the same host.  To
+configure Arvbox to be accessible over a network and for other options see
+http://doc.arvados.org/install/arvbox.html for details.
 
 ## Documentation
 
@@ -55,12 +62,17 @@ contributers to Arvados.
 
 ## Development
 
-[![Build Status](https://ci.curoverse.com/buildStatus/icon?job=arvados-api-server)](https://ci.curoverse.com/job/arvados-api-server/)
+[![Build Status](https://ci.curoverse.com/buildStatus/icon?job=run-tests)](https://ci.curoverse.com/job/run-tests/)
+[![Go Report Card](https://goreportcard.com/badge/github.com/curoverse/arvados)](https://goreportcard.com/report/github.com/curoverse/arvados)
 
 The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues
 
 Continuous integration is hosted at https://ci.curoverse.com/
 
+Instructions for setting up a development environment and working on specific
+components can be found on the
+["Hacking Arvados" page of the Arvados wiki](https://dev.arvados.org/projects/arvados/wiki/Hacking).
+
 ## Licensing
 
 Arvados is Free Software.  See COPYING for information about Arvados Free