summaryrefslogtreecommitdiff
path: root/doc/src/index.rst
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@gmail.com>2016-12-24 12:46:04 +0100
committerFelix Morgner <felix.morgner@gmail.com>2016-12-24 12:46:04 +0100
commit9b02e03c2a6f8a74a83dd40c69719fe36f4dd154 (patch)
tree2994ed54fcc532b035f38afa39b13556556ebf7c /doc/src/index.rst
parent31bb7fd29bca88f86860bdc8aa7f09c3e8e3f111 (diff)
downloadextfs-9b02e03c2a6f8a74a83dd40c69719fe36f4dd154.tar.xz
extfs-9b02e03c2a6f8a74a83dd40c69719fe36f4dd154.zip
Update documentation
Diffstat (limited to 'doc/src/index.rst')
-rw-r--r--doc/src/index.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/src/index.rst b/doc/src/index.rst
new file mode 100644
index 0000000..dee63dd
--- /dev/null
+++ b/doc/src/index.rst
@@ -0,0 +1,15 @@
+Welcome to extfs's documentation!
+=================================
+
+|project_name| is a simple, pure C++ implementation of the ext* family of file
+systems. It provides a simple API to inspect, traverse and modify ext2/3/4
+file systems. |project_name| is designed to be included directly in the build
+process of other projects, that why no binary builds are provided.
+
+User documentation
+------------------
+
+.. toctree::
+ :maxdepth: 2
+
+ api