16080: WIP adding code of conduct, improve community docs

[arvados.git] / README.md

diff --git a/README.md b/README.md
index 2ba181ae82ab7e43d5e5b58699458ab683afdcd2..2e2641db304049fe4fcd5d917b43d7f20ea107bf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-Welcome to Arvados
-==================
+[comment]: # (Copyright © The Arvados Authors. All rights reserved.)
+[comment]: # ()
+[comment]: # (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,26 @@ 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:
+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
 
@@ -39,11 +42,11 @@ doc/README.textile for instructions.
 
 ## Community
 
-The [#arvados](irc://irc.oftc.net:6667/#arvados IRC) (Internet Relay Chat)
-channel at the
-[Open and Free Technology Community (irc.oftc.net)](http://www.oftc.net/oftc/)
-is available for live discussion and support.  You can use a traditional IRC
-client or [join OFTC over the web.](https://webchat.oftc.net/?channels=arvados)
+[![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+The [arvados community channel](https://gitter.im/arvados/community)
+channel at [gitter.im](https://gitter.im) is available for live
+discussion and support.
 
 The
 [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
@@ -51,15 +54,20 @@ is a forum for general discussion, questions, and news about Arvados
 development.  The
 [Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev)
 is a forum for more technical discussion, intended for developers and
-contributers to Arvados.
+contributors 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.arvados.org/buildStatus/icon?job=run-tests)](https://ci.arvados.org/job/run-tests/)
+[![Go Report Card](https://goreportcard.com/badge/github.com/arvados/arvados)](https://goreportcard.com/report/github.com/arvados/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/
+Continuous integration is hosted at https://ci.arvados.org/
+
+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