tauri-apps/archived-cef-rs
1
0
Fork 0
mirror of https://github.com/tauri-apps/cef-rs.git synced 2026-01-31 00:55:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Bill Avery
2025-02-06 22:21:32 -08:00
parent 2776184fab
commit ba4723b4fc
10 changed files with 50 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
cef/README.md Normal file
View File

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

4
cef/src/lib.rs
View File

@@ -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;

4
download-cef/README.md Normal file
View File

@@ -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.

5
download-cef/src/lib.rs
View File

@@ -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};

28
export-cef-dir/README.md Normal file
View File

@@ -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"
```

23
export-cef-dir/src/main.rs
View File

@@ -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};

4
sys/README.md Normal file
View File

@@ -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.

5
sys/src/lib.rs
View File

@@ -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,

5
update-bindings/README.md Normal file
View File

@@ -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.

2
update-bindings/src/main.rs
View File

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