Merge pull request #47 from wravery/dev

fix(doc): move crate doc comments into README files

cef/README.md

@@ -0,0 +1,3 @@
+# cef
+
+Use the [Chromium Embedded Framework](https://github.com/chromiumembedded/cef) in Rust.

cef/src/lib.rs

@@ -1,6 +1,4 @@
-//! # cef
-//!
-//! Use the [Chromium Embedded Framework](https://github.com/chromiumembedded/cef) in Rust.
+#![doc = include_str!("../README.md")]
 
 pub mod args;
 pub mod rc;

download-cef/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "download-cef"
 description = "Download and extract pre-built CEF (Chromium Embedded Framework) archives."
-version = "1.2.1"
+version = "1.2.2"
 
 edition.workspace = true
 license.workspace = true

download-cef/README.md

@@ -0,0 +1,4 @@
+# download-cef
+
+Utility functions to download and extract prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
+archives on any supported platform.

download-cef/src/lib.rs

@@ -1,7 +1,4 @@
-//! # download-cef
-//!
-//! Utility functions to download and extract prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
-//! archives on any supported platform.
+#![doc = include_str!("../README.md")]
 
 use bzip2::bufread::BzDecoder;
 use serde::{Deserialize, Serialize};

export-cef-dir/README.md

@@ -0,0 +1,28 @@
+# export-cef-dir
+
+Export files from the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
+archive on any supported platform. The structure of the exported directory matches the way that
+the `cef-dll-sys` crate expects to see them.
+
+To use the target directory when building, set the `CEF_PATH` environment variable to the path of the
+exported directory, e.g., `~/.local/share/cef`.
+
+To use the DLLs in this directory at runtime, the library loader path varies by platform:
+
+- Linux
+
+```sh
+export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$CEF_PATH"
+```
+
+- macOS
+
+```sh
+export DYLD_FALLBACK_LIBRARY_PATH="$DYLD_FALLBACK_LIBRARY_PATH:$CEF_PATH"
+```
+
+- Windows (using PowerShell)
+
+```pwsh
+$env:PATH = "$env:PATH;$env:CEF_PATH"
+```

export-cef-dir/src/main.rs

@@ -1,25 +1,4 @@
-//! # export-cef-dir
-//!
-//! Export files from the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
-//! archive on any supported platform. The structure of the exported directory matches the way that
-//! the `cef-dll-sys` crate expects to see them.
-//!
-//! To use the target directory when building, set the `CEF_PATH` environment variable to the path of the
-//! exported directory, e.g., `~/.local/share/cef`.
-//!
-//! To use the DLLs in this directory at runtime, the library loader path varies by platform:
-//! - Linux
-//! ```sh
-//! export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$CEF_PATH"
-//! ```
-//! - macOS
-//! ```sh
-//! export DYLD_FALLBACK_LIBRARY_PATH="$DYLD_FALLBACK_LIBRARY_PATH:$CEF_PATH"
-//! ```
-//! - Windows (using PowerShell)
-//! ```pwsh
-//! $env:PATH = "$env:PATH;$env:CEF_PATH"
-//! ```
+#![doc = include_str!("../README.md")]
 
 use clap::Parser;
 use download_cef::{CefIndex, OsAndArch};

sys/README.md

@@ -0,0 +1,4 @@
+# cef-dll-sys
+
+Generated bindings for the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
+C API on any supported platform.

sys/src/lib.rs

@@ -1,7 +1,4 @@
-//! # cef-dll-sys
-//!
-//! Generated bindings for the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
-//! C API on any supported platform.
+#![doc = include_str!("../README.md")]
 
 #[allow(
     non_snake_case,

update-bindings/README.md

@@ -0,0 +1,5 @@
+# update-bindings
+
+Download the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
+archive on any supported platform and run `bindgen` on the C API for the `cef-dll-sys` crate,
+then regenerate the safe bindings in the `cef` crate.

update-bindings/src/main.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate thiserror;