Fixup readme, remove emacs dependency, move unboxing to toplevel

Author: trgwii

.github/workflows/CI.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update
-          sudo apt-get -y install check doxygen emacs
+          sudo apt-get -y install check doxygen
 
       - name: Checkout
         uses: actions/checkout@v4

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "thirdparty/unboxing"]
-	path = thirdparty/unboxing
+[submodule "unboxing"]
+	path = unboxing
 	url = git@github.com:piql/unboxing

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 
 project(afs)
 
-add_subdirectory(thirdparty/unboxing EXCLUDE_FROM_ALL)
+add_subdirectory(unboxing EXCLUDE_FROM_ALL)
 
 add_library(minixml
     thirdparty/minixml/src/mxml-attr.c
@@ -103,8 +103,6 @@ if(BUILD_TESTING)
 
     add_test(NAME afstest COMMAND afstest)
 
-    add_custom_command(OUTPUT ../README.md WORKING_DIRECTORY .. COMMAND emacs README.org --batch -f org-md-export-to-markdown DEPENDS README.org)
-    add_custom_target(readme ALL DEPENDS README.md)
     add_custom_command(OUTPUT ../doc/html/index.html WORKING_DIRECTORY .. COMMAND doxygen doxygen.dox DEPENDS doxygen.dox)
     add_custom_target(doxygen ALL DEPENDS doc/html/index.html)
 endif()

README.md

@@ -1,58 +1,66 @@
-
-
 # Afslib
 
-**afslib** is a library for reading Archival File Systems (**AFS**). The **AFS** has unique preservation capabilites, including support for human readable data, file format ids and other types of metadata. A design goal for **AFS** is to provide a completely self contained file system, containing all information needed to decede and understand its content in the near and distant future. The **AFS** file system is primarily intended for **linear tape storage** mediums.
-
-The key components in the **AFS** is the **zero-reference-mark** indicating the start of the file system, the **control-frame** containing information about how to decode the rest of the reel and the **table-of-content** pointing to all files stored on the reel. The file system is organised into sectors, called **frames**, where a frame occupies a rectangle on the storage medium surface. The frame can contain either visual or digital data. The data on the frame could be encoded using any kind of 2D barcode format. Current instances of AFS uses the boxinglib 2D barcode format.
+**afslib** is a library for reading Archival File Systems (**AFS**). The **AFS**
+has unique preservation capabilites, including support for human readable data,
+file format ids and other types of metadata. A design goal for **AFS** is to
+provide a completely self contained file system, containing all information
+needed to decede and understand its content in the near and distant future. The
+**AFS** file system is primarily intended for **linear tape storage** mediums.
+
+The key components in the **AFS** is the **zero-reference-mark** indicating the
+start of the file system, the **control-frame** containing information about how
+to decode the rest of the reel and the **table-of-content** pointing to all
+files stored on the reel. The file system is organised into sectors, called
+**frames**, where a frame occupies a rectangle on the storage medium surface.
+The frame can contain either visual or digital data. The data on the frame could
+be encoded using any kind of 2D barcode format. Current instances of AFS uses
+the boxinglib 2D barcode format.
 
 See [LICENSE for software licensing.](./LICENSE)
 
-This library contains a version of the third party library Mini-XML, which is Copyright 2003-2016 by Michael R Sweet.
-
+This library contains a version of the third party library Mini-XML, which is
+Copyright 2003-2016 by Michael R Sweet.
 
 # Table of Contents
 
-1.  [Afslib](#afslib)
-2.  [Features](#features)
-3.  [Requirements](#requirements)
-4.  [Installation](#installation)
-    1.  [iVM](#ivm)
-
+1. [Afslib](#afslib)
+2. [Features](#features)
+3. [Requirements](#requirements)
+4. [Installation](#installation)
+   1. [iVM](#ivm)
 
 # Features
 
--   Simple file system with unique preservation capabilities
--   Portable
--   TOC supports both digital and visual data
--   TOC supports file metadata in any format
--   TOC supports file format identification
--   Control frame supports self contained bootstrap for decoding rest of the reel
-
+- Simple file system with unique preservation capabilities
+- Portable
+- TOC supports both digital and visual data
+- TOC supports file metadata in any format
+- TOC supports file format identification
+- Control frame supports self contained bootstrap for decoding rest of the reel
 
 # Requirements
 
 C language compiler supporting C99 (ISO/IEC 9899:1999).
 
 A design goal is to have as few dependencies as possible.
 
-
 # Installation
 
-    git clone https://github.com/piql/afs
-    cd afs
-    ./autogen.sh
-    ./configure LIBUNBOXING_DIR=<absolute path to unboxing>
-    make
-
+```sh
+git clone https://github.com/piql/afs --recurse-submodules
+cd afs
+cmake -Bbuild
+cmake --build build -j
+pushd build
+./afstest
+popd
+```
 
 ## iVM
 
-The iVM virtual machine is a minimal execution environment for file format decoders. Its design goal is to minimize future implementation effort by providing an unambiguous and compact implementation description.
+The iVM virtual machine is a minimal execution environment for file format
+decoders. Its design goal is to minimize future implementation effort by
+providing an unambiguous and compact implementation description.
 
 The afs library is one of the formats the iVM natively supports.
 
-To target the iVM and use the ivm64 compiler:
-
-    CC=ivm64-gcc ./configure --host=ivm64 LIBUNBOXING_DIR=<absolute path to unboxing>
-