From 1ecf849fd5abfced5d6e19def7b5757e2d68153c Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Thu, 3 Mar 2016 10:24:03 -0500 Subject: [PATCH] 8620: Better onramp in README.md so people visiting Github page for Arvados get a sense of what it's about and can try out arvbox. --- README | 39 -------------------------------- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 39 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index cbb6fdde0f..0000000000 --- a/README +++ /dev/null @@ -1,39 +0,0 @@ -Welcome to the Arvados Project! - -Arvados is an open source 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 consists of -a content-addressable storage system "Keep" for managing and storing large -collections of files; a containerized workflow engine "Crunch" designed for -versioning, reproducibilty, and provenance of computations; and a variety -related services and components including APIs, SDKs, and visual tools. - -The main Arvados web site is - https://arvados.org - -The Arvados public wiki is located at - https://dev.arvados.org/projects/arvados/wiki - -The Arvados public bug tracker is located at - https://dev.arvados.org/projects/arvados/issues - -For support see - http://doc.arvados.org/user/getting_started/community.html - -Installation documentation is located at - http://doc.arvados.org/install - -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 Arvados: - - $ cd arvados/tools/arvbox/bin - $ ./arvbox start localdemo - -See http://doc.arvados.org/install/arvbox.html for details and documentation. - -If you wish to build the Arvados documentation yourself, follow the -instructions in doc/README to build the documentation, then consult the -"Install Guide". - -See COPYING for information about Arvados Free Software licenses. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..2ba181ae82 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +Welcome to Arvados +================== + +[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 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. + +* 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: + +``` +$ cd arvados/tools/arvbox/bin +$ ./arvbox start localdemo +``` + +See http://doc.arvados.org/install/arvbox.html for details and documentation. + +## Documentation + +Complete documentation, including a User Guide, Installation documentation and +API documentation is available at http://doc.arvados.org/ + +If you wish to build the Arvados documentation from a local git clone, see +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) + +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 +contributers to Arvados. + +## Development + +[![Build Status](https://ci.curoverse.com/buildStatus/icon?job=arvados-api-server)](https://ci.curoverse.com/job/arvados-api-server/) + +The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues + +Continuous integration is hosted at https://ci.curoverse.com/ + +## Licensing + +Arvados is Free Software. See COPYING for information about Arvados Free +Software licenses. -- 2.30.2