Working on the book

book.toml

@@ -13,4 +13,6 @@ build-dir = "target/book"
 create-missing = true
 
 [output.html]
-mathjax-support = true
+mathjax-support = true
+git-repository-url = "https://github.com/ewpratten/protomask"
+site-url = "/book/"

docs/book/SUMMARY.md

@@ -1,3 +1,10 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+- [Introduction](./introduction.md)
+- [Libraries](./libraries.md)
+
+# User Guides
+
+- [Using `protomask`](./binaries/protomask.md)
+- [Using `protomask-clat`](./binaries/protomask-clat.md)
+

docs/book/binaries/protomask-clat.md

@@ -0,0 +1 @@
+# `protomask-clat` User Guide

docs/book/binaries/protomask.md

@@ -0,0 +1 @@
+# `protomask` User Guide

docs/book/chapter_1.md

@@ -1 +0,0 @@
-# Chapter 1

docs/book/introduction.md

@@ -0,0 +1,11 @@
+# Introduction
+
+Protomask is a user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation geared towards networks that need fast and reliable inter-protocol packet translation. Behind the scenes, protomask uses the [Universal TUN/TAP Device Driver](https://docs.kernel.org/networking/tuntap.html) to translate incoming packets from IPv4 to IPv6 and vice-versa.
+
+For an overview of the project, see the [website](https://protomask.ewpratten.com) or [GitHub repository](https://github.com/ewpratten/protomask).
+
+## Table of Contents
+
+- [Protomask library suite documentation](./libraries.html)
+- [Using `protomask`](./binaries/protomask.html)
+- [Using `protomask-clat`](./binaries/protomask-clat.html)

docs/book/libraries.md

@@ -0,0 +1,11 @@
+# Libraries
+
+The protomask library suite is a collection of libraries that were originally developed for use in the protomask tool suite, but are also quite useful outside of the scope of this project.
+
+These libraries are thoroughly documented in their respective docs.rs crate pages:
+
+- [`easy-tun`: A minimal TUN interface library](https://docs.rs/easy-tun)
+- [`fast-nat`: A library designed for highly efficient mapping and lookup of IP address pairs](https://docs.rs/fast-nat)
+- [`interproto`: A library for translating packets between protocols](https://docs.rs/interproto)
+- [`rfc6052`: A Rust implementation of RFC6052](https://docs.rs/rfc6052)
+- [`rtnl`: A high-level wrapper around `rtnetlink`](https://docs.rs/rtnl)