From 13ae6040973a3949a75e334efe3259ed3f9b4579 Mon Sep 17 00:00:00 2001
From: Hanno Braun <hanno@braun-odw.eu>
Date: Wed, 26 Jan 2022 15:18:36 +0100
Subject: [PATCH] Add crate-level documentation to `fj`

---
 fj/src/lib.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/fj/src/lib.rs b/fj/src/lib.rs
index 3a6584af3..7a04c27a7 100644
--- a/fj/src/lib.rs
+++ b/fj/src/lib.rs
@@ -1,3 +1,15 @@
+//! Fornjot modeling library
+//!
+//! The purpose of this library is to support Fornjot models, which are just
+//! Rust libraries. Models depend on this library and use the primitives defined
+//! here to define a CAD model.
+//!
+//! To actually display the CAD model, or export it to another file format, you
+//! need the host application. Please refer to the [Fornjot repository] for
+//! usage examples.
+//!
+//! [Fornjot repository]: https://github.com/hannobraun/Fornjot
+
 mod shape_2d;
 mod shape_3d;
 mod syntax;