summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2020-06-13 00:37:29 +0200
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2020-06-13 00:37:29 +0200
commit89406b2996c7b173787b29ee34d6ee9ffd0a711c (patch)
tree380d99d5b2121023b3080306988985d3da1d91cd /doc
parent42d718c0b129f2cd50b271583d362e94e269e39c (diff)
Minor documentation update
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/mainpage.dox13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index c676481..b9822ac 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -15,5 +15,18 @@
* SquashFS in a custom container format or applying custom transformations on
* the raw byte level.
*
+ * If want to get started with reading SquashFS images, a good starting point
+ * would be the @ref sqfs_data_reader_t and @ref sqfs_dir_reader_t that
+ * provide an interface for browsing a SquashFS directory tree and reading
+ * data contained within.
+ *
+ * A few helper structures are need for that tough, specifically the SquashFS
+ * super block (see @ref sqfs_super_t) that can be read from a
+ * @ref sqfs_file_t using @ref sqfs_super_read.
+ *
+ * A decompressor (see @ref sqfs_compressor_t) is also needed, which can be
+ * created using @ref sqfs_compressor_config_init and
+ * @ref sqfs_compressor_create.
+ *
* @example list_files.c
*/