Add a first outline for the documentation

RKrahl · Dec 2, 2023 · 2bba2f0 · 2bba2f0
1 parent 03e69e2
commit 2bba2f0
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 3 deletions.
diff --git a/doc/src/about.rst b/doc/src/about.rst
@@ -0,0 +1,6 @@
+About archive-tools
+===================
+
+..
+    What is archive-tools?  Why is it useful?  What are the design
+    ideas and features?
diff --git a/doc/src/index.rst b/doc/src/index.rst
@@ -1,10 +1,22 @@
-archive-tools
-=============
+Tools for managing archives
+===========================
+
+This package provides tools for managing archives.  An archive in
+terms of this package is a (compressed) tar archive file with some
+embedded metadata on the included files.  This metadata include the
+name, file stats, and checksums of the file.
+
+Content of the documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
+   about
+   install
+   usage
+   scripts
+   moduleref
    changelog
 
 

diff --git a/doc/src/install.rst b/doc/src/install.rst
@@ -0,0 +1,5 @@
+Installation instructions
+=========================
+
+..
+    System requirements, Download, Installation
diff --git a/doc/src/moduleref.rst b/doc/src/moduleref.rst
@@ -0,0 +1,5 @@
+Module reference
+================
+
+..
+    provide a reference for the archive-tool modules
diff --git a/doc/src/scripts.rst b/doc/src/scripts.rst
@@ -0,0 +1,5 @@
+Command line scripts
+====================
+
+..
+    man page for archive-tool (and for backup-tool?)
diff --git a/doc/src/usage.rst b/doc/src/usage.rst
@@ -0,0 +1,8 @@
+Using archive-tools
+===================
+
+..
+    Describe the basic functionality: create an archive, list the
+    contents, list checksums, check the integrity, show informations
+    about an entry, check if files are in the archive, diff archives,
+    find files