From 0e4c66d19fc6f734f721855553cb9cb457191916 Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Mon, 25 Jun 2018 14:53:43 -0400 Subject: [PATCH] Add README.md refs #13650 Arvados-DCO-1.1-Signed-off-by: Ward Vandewege --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0be4706 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +[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 +sets. Arvados supports a variety of cloud, cluster and HPC environments. + +## Arvados on Kubernetes + +This repository contains a Helm chart for Arvados. + +Documentation can be found at [http://doc.arvados.org/install/arvados-on-kubernetes.html](http://doc.arvados.org/install/arvados-on-kubernetes.html) + +## 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) + +The +[Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados) +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 +contributors to Arvados. + +## Development + +[![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). + +## 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 + +Arvados is Free Software. See COPYING for information about Arvados Free +Software licenses. -- 2.30.2