https://github.com/timvisee/qr2term-rs

:bar_chart: Stupidly simple Rust crate to render a QR code in the terminal.
https://github.com/timvisee/qr2term-rs

hacktoberfest qrcode rust-library terminal

Last synced: 2 days ago
JSON representation

:bar_chart: Stupidly simple Rust crate to render a QR code in the terminal.

• Host: GitHub
• URL: https://github.com/timvisee/qr2term-rs
• Owner: timvisee
• License: mpl-2.0
• Created: 2019-03-14T20:44:14.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-21T10:59:24.000Z (12 months ago)
• Last Synced: 2024-05-02T00:57:50.947Z (8 months ago)
• Topics: hacktoberfest, qrcode, rust-library, terminal
• Language: Rust
• Homepage: https://gitlab.com/timvisee/qr2term-rs
• Size: 129 KB
• Stars: 49
• Watchers: 3
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status on GitLab CI][gitlab-ci-master-badge]][gitlab-ci-link]

[![Newest release on crates.io][crate-version-badge]][crate-link]

[![Documentation][docs-badge]][docs]

[![Number of downloads on crates.io][crate-download-badge]][crate-link]

[![Project license][crate-license-badge]](LICENSE)

[crate-download-badge]: https://img.shields.io/crates/d/qr2term.svg

[crate-license-badge]: https://img.shields.io/crates/l/qr2term.svg

[crate-link]: https://crates.io/crates/qr2term

[crate-version-badge]: https://img.shields.io/crates/v/qr2term.svg

[docs-badge]: https://docs.rs/qr2term/badge.svg

[docs]: https://docs.rs/qr2term

[gitlab-ci-link]: https://gitlab.com/timvisee/qr2term-rs/pipelines

[gitlab-ci-master-badge]: https://gitlab.com/timvisee/qr2term-rs/badges/master/pipeline.svg

# Rust library: qr2term

A stupidly simple QR code renderer, that prints text as QR code to the terminal,

and nothing else.

[`example.rs`](./examples/example.rs):

```rust

fn main() {

    qr2term::print_qr("https://rust-lang.org/");

}

```

![qr2term example screenshot](./res/qr2term-example.png)

This library is based on [`qair`](https://code.willemp.be/willem/qair),

which didn't provide the renderer as a library on it's own.

Credits for the actual renderer go to it's developer.

To read a text from the command line and encode it in QR form, run:

```bash

$ echo HelloWorld | cargo run --example example-read

```

To create WiFi credentials in QR form, run:

```bash

$ echo HelloWorld | cargo run --example example-wifi

```

## License

This project is licensed under the MPL 2.0 license.

Check out the [LICENSE](LICENSE) file for more information.