Merge pull request #4 from YushiOMOTE/update-for-latest-rust

Update for latest rust

.github/workflows/rust.yml

@@ -7,12 +7,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
+      - name: Build (Stable)
+        run: cargo build --verbose
+      - name: Test (Stable)
+        run: cargo build --verbose
       - name: Install nightly
         uses: actions-rs/toolchain@v1
         with:
           toolchain: nightly
           override: true
-      - name: Build
-        run: cargo build --verbose --features readme
-      - name: Test
-        run: cargo test --verbose --features readme
+      - name: Build (Nightly)
+        run: cargo build --verbose
+      - name: Test (Nightly)
+        run: cargo test --verbose

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "com_logger"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Yushi OMOTE <yushiomote@gmail.com>"]
 edition = "2018"
 description = "Serial port logger through COM ports"
@@ -10,10 +10,6 @@ documentation = "https://docs.rs/com_logger"
 license = "MIT"
 readme = "README.md"
 
-[features]
-default = []
-readme = []
-
 [dependencies]
 uart_16550 = "0.2"
 log = { version = "0.4", default-features = false }

README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Actions Status](https://github.com/YushiOMOTE/com_logger/workflows/Rust/badge.svg)](https://github.com/YushiOMOTE/com_logger/actions)
 
-Serial port logger through COM ports.
+Serial port logger through [COM ports](https://en.wikipedia.org/wiki/COM_(hardware_interface)).
 
 * Doesn't require `std` (`no_std`)
 * Doesn't require `alloc`

src/lib.rs

@@ -1,39 +1,6 @@
-//!
-//! `com_logger` is a logger through COM port.
-//!
-//! This library is `no_std`, and doesn't rely on `alloc`.
-//!
-//! ```rust,no_run
-//! use log::*;
-//!
-//! fn main() {
-//!    com_logger::init();
-//!
-//!    info!("Hello");
-//! }
-//! ```
-//!
-//! The serial port base address and logging level filter can be configured.
-//!
-//! ```rust,no_run
-//! use log::*;
-//!
-//! fn main() {
-//!    com_logger::builder()
-//!        .base(0x2f8)                  // Use COM2 port
-//!        .filter(LevelFilter::Debug)   // Print debug log
-//!        .setup();
-//!
-//!    debug!("Hello");
-//! }
-//! ```
-
 #![no_std]
-#![cfg_attr(feature = "readme", feature(external_doc))]
 #![warn(missing_docs)]
-
-#[cfg_attr(feature = "readme", doc(include = "../README.md"))]
-type _Readme = ();
+#![doc = include_str!("../README.md")]
 
 /// The module for the logger.
 mod logger;