summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
-rw-r--r--doc/mainpage.dox13
2 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 520f41c..c38d4bf 100644
--- a/README.md
+++ b/README.md
@@ -196,3 +196,14 @@ found in the [documentation directory](doc/format.txt), which is based on
an online version that can be found here:
https://dr-emann.github.io/squashfs/
+
+
+The closest thing to an official web site can be found here:
+
+https://infraroot.at/projects/squashfs-tools-ng/index.html
+
+This location also hosts the Doxygen reference manual for the latest release.
+
+There is currently no official mailing list. So far I used the squashfs-tools
+mailing list on SourceForge for announcments and I will continue to do so
+until I am booted off.
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
*/