Skip to content

Commit 476fea2

Browse files
committed
Cleanup lib.rs a little.
1 parent 7268bcb commit 476fea2

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

src/lib.rs

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
//! # Gerber-parser
22
//!
3-
//! This is a simple parser in rust for Gerber file (or string). The underlying representation
4-
//! is built on the `gerber-types` crate.
3+
//! This is a parser in rust for Gerber file. The underlying representation is built on the `gerber-types` crate.
54
//!
65
//! Gerber files are the de-facto file format for PCB manufacturing, but are also used in other
76
//! context, such as in microfabrication. It is an old format with a lot of baggage, but the
87
//! [specification is well documented](https://www.ucamco.com/en/guest/downloads/gerber-format),
98
//! there is an [online free viewer available](https://gerber-viewer.ucamco.com/) to check your designs,
109
//! and the format is plaintext making it easy to work with.
1110
//!
12-
//! As the crate is still in the early version, expect significant changes over time, as both this
13-
//! crate and `gerber-types` will need to undergo changes.
11+
//! There are sibling crates to this crate, as follows:
12+
//!
13+
//! * gerber-types - underlying types for the parser - https://github.com/MakerPnP/gerber-types
14+
//! * gerber-viewer - a pure rust gerber viewer - https://github.com/MakerPnP/gerber-viewer
15+
//!
16+
//! This crate has matured, the API is simple and should be fairly stable now. This crate is the primary driver to
17+
//! changes for the gerber-types crate.
1418
15-
// Public modules
16-
pub mod util;
1719
#[macro_use]
1820
mod macros;
1921

22+
// Public modules
23+
pub mod util;
24+
2025
// Private modules - we re-export the public types from them below
2126
mod document;
2227
mod error;

0 commit comments

Comments
 (0)