diff options
| author | David Sterba <dsterba@suse.com> | 2015-10-27 16:30:22 +0100 |
|---|---|---|
| committer | David Sterba <dsterba@suse.com> | 2015-11-02 15:10:13 +0100 |
| commit | fea963541afca6694b757f230574f38769a67fdb (patch) | |
| tree | bd4cfd760788385280de1987ed4abbd3bcb89632 /README.md | |
| parent | e4706adbe0240e97fb8f81d2639d0e9d9c8345e9 (diff) | |
btrfs-progs: add an initial README
Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..2f9d4e7e --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +Btrfs-progs +=========== + +Userspace utilities to manage btrfs filesystems. +License: GPLv2. + +Btrfs is a copy on write (COW) filesystem for Linux aimed at implementing +advanced features while focusing on fault tolerance, repair and easy +administration. + + +This repository hosts following utilities: + +* **btrfs** — the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs)) +* **mkfs.btrfs** — utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs)) + +See INSTALL for build instructions. + +Release cycle +------------- + +The major version releases are time-based and follow the cycle of the linux +kernel releases. The cycle usually takes 2 months. A minor version releases may +happen in the meantime if there are queued bug fixes or minor useful +improvements. + +Development +----------- + +The patch submissions, development or general discussions take place at +*linux-btrfs@vger.kernel.org* mailinglist, subsciption not required. + +References +---------- + +* [Wiki with more information](https://btrfs.wiki.kernel.org) +* [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29) +* [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ) +* [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started) +* [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects) +* [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ) |