RQRCode 项目技术文档

1. 安装指南

1.1 使用 Gemfile 安装

在你的应用程序的 Gemfile 中添加以下行：

gem "rqrcode", "~> 2.0"

然后运行 bundle install 来安装依赖。

1.2 手动安装

你也可以手动安装 rqrcode 库：

gem install rqrcode

2. 项目的使用说明

2.1 基本用法

首先，你需要在代码中引入 rqrcode 库：

require "rqrcode"

然后，你可以创建一个 QR 码对象，并将其输出为字符串：

qr = RQRCode::QRCode.new("https://kyan.com")
puts qr.to_s

默认情况下，输出的字符串可能不易读。你可以使用不同的渲染选项来生成更易读的 QR 码。

2.2 高级选项

rqrcode 提供了多种生成 QR 码的选项，包括：

• data：要编码的字符串或数组。
• size：QR 码的大小（默认为所需的最小大小）。
• max_size：QR 码的最大大小（默认值为 RQRCodeCore::QRUtil.max_size）。
• level：错误纠正级别，可以是 :l、:m、:q 或 :h（默认 :h）。
• mode：编码模式，可以是 :number、:alphanumeric、:byte_8bit 或 :kanji（默认根据输入数据自动选择）。

示例：

simple_qrcode = RQRCodeCore::QRCode.new("https://kyan.com", size: 2, level: :m, mode: :byte_8bit)

3. 项目API使用文档

3.1 渲染类型

rqrcode 提供了多种渲染选项，包括 as_svg、as_png 和 as_ansi。

3.1.1 as_svg

生成 SVG 格式的 QR 码：

qrcode = RQRCode::QRCode.new("http://github.com/")
svg = qrcode.as_svg(
  color: "000",
  shape_rendering: "crispEdges",
  module_size: 11,
  standalone: true,
  use_path: true
)

3.1.2 as_png

生成 PNG 格式的 QR 码：

qrcode = RQRCode::QRCode.new("http://github.com/")
png = qrcode.as_png(
  bit_depth: 1,
  border_modules: 4,
  color_mode: ChunkyPNG::COLOR_GRAYSCALE,
  color: "black",
  file: nil,
  fill: "white",
  module_px_size: 6,
  resize_exactly_to: false,
  resize_gte_to: false,
  size: 120
)
IO.binwrite("/tmp/github-qrcode.png", png.to_s)

3.1.3 as_ansi

生成带有 ANSI 颜色代码的 QR 码：

qrcode = RQRCode::QRCode.new("http://github.com/")
ansi = qrcode.as_ansi(
  light: "\033[47m", dark: "\033[40m",
  fill_character: "  ",
  quiet_zone_size: 4
)

4. 项目安装方式

4.1 使用 Bundler

在 Gemfile 中添加：

gem "rqrcode", "~> 2.0"

然后运行 bundle install。

4.2 手动安装

直接使用 gem install 命令：

gem install rqrcode

通过以上步骤，你可以轻松安装并使用 rqrcode 库来生成各种格式的 QR 码。