From 521abcc49a73ac5187f58807b8599de04d9d9765 Mon Sep 17 00:00:00 2001 From: Matthew Ahrens Date: Tue, 25 Feb 2020 11:43:20 -0800 Subject: [PATCH] Update README for OpenZFS Reviewed-by: Brian Behlendorf Signed-off-by: Matthew Ahrens Closes #10053 --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 150ba0f2c3f3..ff8a0e851305 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,36 @@ -![img](https://zfsonlinux.org/images/zfs-linux.png) +![img](https://github.com/openzfs/zfs/wiki/img/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png) -ZFS on Linux is an advanced file system and volume manager which was originally +OpenZFS is an advanced file system and volume manager which was originally developed for Solaris and is now maintained by the OpenZFS community. +This repository contains the code for running OpenZFS on Linux and FreeBSD. -[![codecov](https://codecov.io/gh/zfsonlinux/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/zfsonlinux/zfs) -[![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/zfsonlinux-zfs) +[![codecov](https://codecov.io/gh/openzfs/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/openzfs/zfs) +[![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/openzfs-zfs) # Official Resources - * [Site](https://zfsonlinux.org) - * [Wiki](https://github.com/zfsonlinux/zfs/wiki) - * [Mailing lists](https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists) - * [OpenZFS site](http://open-zfs.org/) + * [Wiki](https://github.com/openzfs/zfs/wiki) - for using and developing this repo + * [ZoL Site](https://zfsonlinux.org) - Linux release info & links + * [Mailing lists](https://github.com/openzfs/zfs/wiki/Mailing-Lists) + * [OpenZFS site](http://open-zfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc) # Installation -Full documentation for installing ZoL on your favorite Linux distribution can -be found at [our site](https://zfsonlinux.org/). +Full documentation for installing OpenZFS on your favorite Linux distribution can +be found at the [ZoL Site](https://zfsonlinux.org/). + +FreeBSD support is a work in progress. See the [PR](https://github.com/openzfs/zfs/pull/8987). # Contribute & Develop We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md). +We have a [Code of Conduct](./CODE_OF_CONDUCT.md). + # Release -ZFS on Linux is released under a CDDL license. +OpenZFS is released under a CDDL license. For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197` # Supported Kernels - * The `META` file contains the officially recognized supported kernel versions. + * The `META` file contains the officially recognized supported Linux kernel versions.