etc/init.d: decide which variant to use at build time.

[mirror_zfs.git] / README.md

diff --git a/README.md b/README.md
index 64283ec54e420c2bc93e47090886e1786a13ea49..af244c1fff147aaeb495f432906ecc270e1da626 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,21 +1,35 @@
-![img](http://zfsonlinux.org/images/zfs-linux.png)
+![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
 
-The Solaris Porting Layer, SPL, is a Linux kernel module which provides a
-compatibility layer used by the [ZFS on Linux](http://zfsonlinux.org) project.
+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/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
+
+  * [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
+  * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
+  * [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
+  * [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
 
 # Installation
 
-The latest version of the SPL is maintained as part of the ZFS on Linux
-Github repository:
+Full documentation for installing OpenZFS on your favorite operating system can
+be found at the [Getting Started Page](https://openzfs.github.io/openzfs-docs/Getting%20Started/index.html).
 
-  * Latest Version: https://github.com/zfsonlinux/zfs  
+# Contribute & Develop
 
-Cloning this repository is only needed when building version 0.7.x or earlier.
+We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
 
-  * Version 0.7.x: https://github.com/zfsonlinux/spl/tree/spl-0.7-release  
-  * Version 0.6.5.x: https://github.com/zfsonlinux/spl/tree/spl-0.6.5-release  
+We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
 
 # Release
 
-The SPL is released under a GPLv2 license. For more details see the NOTICE
-and LICENSE files; `UCRL-CODE-235197`
+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 Linux kernel versions.
+  * Supported FreeBSD versions are any supported branches and releases starting from 12.4-RELEASE.