X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/88c498466ea5b6d676fad36d8d341b40bec2cd36..b8addea7d6c8c464a2743191561470332eeaba13:/README.md diff --git a/README.md b/README.md index 43485c4e7b..12fdd219fc 100644 --- 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,17 +11,15 @@ 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 -Curoverse maintains an Arvados public cloud demo at -[https://cloud.curoverse.com](https://cloud.curoverse.com). A Google account -is required to log in. +Veritas Genetics maintains a public installation of Arvados for evaluation and trial use, the [Arvados Playground](https://playground.arvados.org). 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 @@ -45,7 +44,7 @@ doc/README.textile for instructions. ## Community -The [#arvados](irc://irc.oftc.net:6667/#arvados IRC) (Internet Relay Chat) +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 @@ -57,19 +56,24 @@ 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.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/ -You can use Arvbox as a self-contained Arvados development environment using -`arvbox start dev` and run the Arvados test suite with `arvbox start test`. -See http://doc.arvados.org/install/arvbox.html for details. +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). + +## Contributing + +When making a pull request, please ensure *every git commit message* includes a one-line [Developer Certificate of Origin](https://dev.arvados.org/projects/arvados/wiki/Developer_Certificate_Of_Origin). If you have already made commits without it, fix them with `git commit --amend` or `git rebase`. ## Licensing