Duplicate README file into micropb/ directory

YuhanLiin · Jul 14, 2024 · e6959cf · e6959cf
1 parent 8021201
commit e6959cf
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,14 @@ name: test suite
 on: [push, pull_request]
 
 jobs:
-  check_and_test:
+  sync-readme:
+    name: check that README.md files are synced
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: diff REAME.txt micropb/README.md
+
+  check-and-test:
     name: check and test workspace with ${{matrix.toolchain}}
     runs-on: ubuntu-latest
     strategy:

diff --git a/micropb/src/lib.rs b/micropb/src/lib.rs
@@ -1,4 +1,4 @@
-#![doc = include_str!("../../README.md")]
+#![doc = include_str!("../README.md")]
 #![warn(missing_docs)]
 #![cfg_attr(not(any(feature = "std", doc)), no_std)]