]> git.proxmox.com Git - mirror_zfs.git/blobdiff - README.md
Fix errant EFAULT during writes (#8719)
[mirror_zfs.git] / README.md
index 64283ec54e420c2bc93e47090886e1786a13ea49..59d167f8ec1e71c4738a164c60a00212ec77e8ad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,21 +1,31 @@
 ![img](http://zfsonlinux.org/images/zfs-linux.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.
+ZFS on Linux is an advanced file system and volume manager which was originally
+developed for Solaris and is now maintained by the OpenZFS community.
 
-# Installation
+[![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)
+
+# Official Resources
 
-The latest version of the SPL is maintained as part of the ZFS on Linux
-Github repository:
+  * [Site](http://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/)
 
-  * Latest Version: https://github.com/zfsonlinux/zfs  
+# Installation
 
-Cloning this repository is only needed when building version 0.7.x or earlier.
+Full documentation for installing ZoL on your favorite Linux distribution can
+be found at [our site](http://zfsonlinux.org/).
 
-  * 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  
+# Contribute & Develop
+
+We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
 
 # Release
 
-The SPL is released under a GPLv2 license. For more details see the NOTICE
-and LICENSE files; `UCRL-CODE-235197`
+ZFS on Linux 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.