xref: /freebsd/sys/contrib/openzfs/README.md (revision ce4dcb97ca433b2a2f03fbae957dae0ff16f6f51) 
1eda14cbcSMatt Macy![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
2eda14cbcSMatt Macy
3eda14cbcSMatt MacyOpenZFS is an advanced file system and volume manager which was originally
4eda14cbcSMatt Macydeveloped for Solaris and is now maintained by the OpenZFS community.
5eda14cbcSMatt MacyThis repository contains the code for running OpenZFS on Linux and FreeBSD.
6eda14cbcSMatt Macy
7eda14cbcSMatt Macy[![codecov](https://codecov.io/gh/openzfs/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/openzfs/zfs)
8eda14cbcSMatt Macy[![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/openzfs-zfs)
9eda14cbcSMatt Macy
10eda14cbcSMatt Macy# Official Resources
11eda14cbcSMatt Macy
12eda14cbcSMatt Macy  * [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
13eda14cbcSMatt Macy  * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
14eda14cbcSMatt Macy  * [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
15e92ffd9bSMartin Matuska  * [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
16eda14cbcSMatt Macy
17eda14cbcSMatt Macy# Installation
18eda14cbcSMatt Macy
19180f8225SMatt MacyFull documentation for installing OpenZFS on your favorite operating system can
20180f8225SMatt Macybe found at the [Getting Started Page](https://openzfs.github.io/openzfs-docs/Getting%20Started/index.html).
21eda14cbcSMatt Macy
22eda14cbcSMatt Macy# Contribute & Develop
23eda14cbcSMatt Macy
24eda14cbcSMatt MacyWe have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
25eda14cbcSMatt Macy
26eda14cbcSMatt MacyWe have a [Code of Conduct](./CODE_OF_CONDUCT.md).
27eda14cbcSMatt Macy
28eda14cbcSMatt Macy# Release
29eda14cbcSMatt Macy
30eda14cbcSMatt MacyOpenZFS is released under a CDDL license.
31eda14cbcSMatt MacyFor more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
32eda14cbcSMatt Macy
33eda14cbcSMatt Macy# Supported Kernels
34eda14cbcSMatt Macy  * The `META` file contains the officially recognized supported Linux kernel versions.
35*ce4dcb97SMartin Matuska  * Supported FreeBSD versions are any supported branches and releases starting from 13.0-RELEASE.
36