freebsd: Use compiler.h from FreeBSD's base's linuxkpi
[zfs.git] / README.md
bloba90736bb56b764707ef79f8821fd02c9b9dfd286
1 ![img](https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png)
3 OpenZFS is an advanced file system and volume manager which was originally
4 developed for Solaris and is now maintained by the OpenZFS community.
5 This repository contains the code for running OpenZFS on Linux and FreeBSD.
7 [![codecov](https://codecov.io/gh/openzfs/zfs/branch/master/graph/badge.svg)](https://codecov.io/gh/openzfs/zfs)
8 [![coverity](https://scan.coverity.com/projects/1973/badge.svg)](https://scan.coverity.com/projects/openzfs-zfs)
10 # Official Resources
12   * [Documentation](https://openzfs.github.io/openzfs-docs/) - for using and developing this repo
13   * [ZoL Site](https://zfsonlinux.org) - Linux release info & links
14   * [Mailing lists](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%20Lists.html)
15   * [OpenZFS site](https://openzfs.org/) - for conference videos and info on other platforms (illumos, OSX, Windows, etc)
17 # Installation
19 Full documentation for installing OpenZFS on your favorite operating system can
20 be found at the [Getting Started Page](https://openzfs.github.io/openzfs-docs/Getting%20Started/index.html).
22 # Contribute & Develop
24 We have a separate document with [contribution guidelines](./.github/CONTRIBUTING.md).
26 We have a [Code of Conduct](./CODE_OF_CONDUCT.md).
28 # Release
30 OpenZFS is released under a CDDL license.
31 For more details see the NOTICE, LICENSE and COPYRIGHT files; `UCRL-CODE-235197`
33 # Supported Kernels
34   * The `META` file contains the officially recognized supported Linux kernel versions.
35   * Supported FreeBSD versions are any supported branches and releases starting from 13.0-RELEASE.