chore: Merge pull request #2 from jhg/use-external-doc-include-nightly

Use external doc include nightly

Author: Jesus H

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
         features: [ 'std', 'alloc', 'std,lender', 'alloc,lender' ]
     runs-on: ${{ matrix.os }}
     timeout-minutes: 5
-    if: github.event_name != 'schedule' && github.event_name != 'workflow_dispatch' && !endsWith(github.ref, '-nightly')
+    if: github.event_name != 'schedule' && github.event_name != 'workflow_dispatch' && !endsWith(github.ref, '-nightly') && !endsWith(github.head_ref, '-nightly')
     steps:
     - uses: actions/checkout@v2
     - uses: actions-rs/toolchain@v1
@@ -50,7 +50,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     timeout-minutes: 5
-    if: github.event_name != 'schedule' && github.event_name != 'workflow_dispatch' && !endsWith(github.ref, '-nightly') && !contains(github.ref, 'refs/tags/v')
+    if: github.event_name != 'schedule' && github.event_name != 'workflow_dispatch' && !endsWith(github.ref, '-nightly') && !endsWith(github.head_ref, '-nightly') && !contains(github.ref, 'refs/tags/v')
     steps:
     - uses: actions/checkout@v2
     - uses: actions-rs/toolchain@v1

src/lib.rs

@@ -1,7 +1,4 @@
-//! FFI opaque pointers.
-//!
-//! FFI to use Rust objects from C as opaque pointer.
-
+#![doc = include_str!("../README.md")] // This also allow to run examples in that file.
 #![allow(unsafe_code)]
 #![warn(missing_docs)]
 #![warn(clippy::pedantic)]