From f0227369fc070f7da5635f88483ba5e1e940e4d3 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Tue, 20 Jun 2023 13:22:20 +0200 Subject: [PATCH] Update *Overview* section in README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 554308954..baecf69cd 100644 --- a/README.md +++ b/README.md @@ -35,18 +35,21 @@ Fornjot is usable for some toy examples, but currently lacks the features for so This is a list of the crates that make up Fornjot, along with a short description for each, starting with the most basic ones and leading up to the high-level ones: -- `fj` (not published yet; crate on `crates.io` is not the same library): All-in-one API that re-exports all of the following crates. +- [`fj`]: All-in-one API that re-exports all of the following crates. - [`fj-math`]: Math primitives used by the rest of Fornjot. - [`fj-interop`]: Basic types that allow other crates to interoperate, without depending on each other. -- `fj-core` (not published yet): Core primitives and code operating on those primitives. +- [`fj-core`]: Core primitives and code operating on those primitives. - [`fj-export`]: Exports Fornjot models to external data formats. - [`fj-viewer`]: Displays Fornjot models. -- `fj-window` (not published yet; crate on `crates.io` is not the same library): Simple windowing abstraction for use with `fj-viewer`. +- [`fj-window`]: Simple windowing abstraction for use with `fj-viewer`. +[`fj`]: https://crates.io/crates/fj +[`fj-core`]: https://crates.io/crates/fj-core [`fj-export`]: https://crates.io/crates/fj-export [`fj-interop`]: https://crates.io/crates/fj-interop [`fj-math`]: https://crates.io/crates/fj-math [`fj-viewer`]: https://crates.io/crates/fj-viewer +[`fj-window`]: https://crates.io/crates/fj-window ## Usage