README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

#extfs
**NOTE:** this library is in very early development

**extfs** is a simple implementation of the ext family (2/3/4) of file systems.

[![Documentation Status](https://readthedocs.org/projects/extfs/badge/?version=latest)](http://extfs.readthedocs.io/?badge=latest) [![Build Status](https://travis-ci.org/fmorgner/extfs.svg?branch=master)](https://travis-ci.org/fmorgner/extfs) [![Coverage Status](https://coveralls.io/repos/github/fmorgner/extfs/badge.svg?branch=master)](https://coveralls.io/github/fmorgner/extfs?branch=master)

#Disclaimer
I take no responsibility for any damage done to your main file system or other
data.

#Requirements
  - [base] Probably some flavor of Linux (tested on **Arch**)
  - [build] A C++17 capable compiler (e.g modern **GCC** or **Clang**)
  - [build] **CMake** (tested on 3.6, should work down to 3.2)
  - [build] Some build tool supported by cmake (**GNU Autotools**, **Ninja**, etc.)
  - [build] **Conan**
  - [testing] **e2fsprogs**

#Building
```bash
$ git clone https://github.com/fmorgner/extfs.git
$ cd extfs/build
$ cmake ..
$ cmake --build . -- -j$(nproc)
```

##Build options
| Option                   | Default | Description                        |
| ------------------------ | ------- | ---------------------------------- |
| EXTFS_BUILD_STATIC       | On      | Build libextfs as a static library |
| EXTFS_ENABLE_RTTI        | On      | Enable runtime type information    |
| EXTFS_ENABLE_EXCEPTIONS  | On      | Enable C++ exceptions              |