1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
#![doc(
html_logo_url = "https://raw.githubusercontent.com/kruserr/cli-pdf-reader/main/assets/logo/logo.svg",
html_favicon_url = "https://raw.githubusercontent.com/kruserr/cli-pdf-reader/main/assets/logo/favicon.ico"
)]
//! <p align="center">
//! <a href="https://github.com/kruserr/cli-pdf-reader" target="_blank">
//! <img width="300" src="https://raw.githubusercontent.com/kruserr/cli-pdf-reader/main/assets/logo/logo.svg">
//! </a>
//! </p>
//!
//! # cli-pdf-reader
//! A minimalistic CLI PDF reader
//!
//! ## Features
//! - Converts PDF to plain text
//! - Justifies the plain text to specified column width
//! - Centers the text based on the width of the terminal
//! - Uses a minimalistic less like interactive reader
//! - Written in pure rust
//! - Statically linked single binary executable
//! - Cross platform
//!
//! ## Getting Started
//! ### Cargo
//! Install and run with cargo
//! ```sh
//! cargo install --locked cli-pdf-reader
//! cli-pdf-reader document.pdf
//! ```
//!
//! ### Git and cargo
//! Clone the repo, build from source and run
//! ```sh
//! git clone https://github.com/kruserr/cli-pdf-reader.git
//! cd cli-pdf-reader
//! cargo install --locked --path .
//! cli-pdf-reader document.pdf
//! ```