Skip to content

Commit

Permalink
Merge pull request #86 from hannobraun/docs
Browse files Browse the repository at this point in the history
Add crate-level documentation to `fj`
  • Loading branch information
hannobraun authored Jan 26, 2022
2 parents e708749 + 13ae604 commit 8fba688
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions fj/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down

0 comments on commit 8fba688

Please sign in to comment.