Ruby Readability 项目教程

54 0 0

Ruby Readability 项目教程

ruby-readabilityPort of arc90’s readability project to Ruby项目地址:https://gitcode.com/gh_mirrors/ru/ruby-readability

1. 项目的目录结构及介绍

Ruby Readability 项目的目录结构如下：

. ├── bin ├── lib ├── spec ├── .gitignore ├── .rspec ├── .yardopts ├── CHANGES.markdown ├── Gemfile ├── Guardfile ├── LICENSE ├── README.md ├── Rakefile └── ruby-readability.gemspec

目录介绍

bin: 包含可执行文件。
lib: 包含项目的核心代码。
spec: 包含测试文件。
.gitignore: 指定 Git 忽略的文件和目录。
.rspec: 包含 RSpec 的配置选项。
.yardopts: 包含 Yard 文档生成工具的配置选项。
CHANGES.markdown: 记录项目的变更历史。
Gemfile: 指定项目的依赖。
Guardfile: 包含 Guard 的配置，用于自动化任务。
LICENSE: 项目的许可证。
README.md: 项目的介绍和使用说明。
Rakefile: 包含 Rake 任务。
ruby-readability.gemspec: 项目的 gem 规范文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin 目录下。通常，这个目录包含可执行文件，用于启动项目或执行特定任务。例如：

bin/ └── ruby-readability

ruby-readability 文件是一个可执行脚本，用于启动 Ruby Readability 工具。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

Gemfile: 指定项目的依赖。例如：

source 'https://rubygems.org' gem 'ruby-readability'

ruby-readability.gemspec: 项目的 gem 规范文件，包含项目的元数据和依赖。例如：


Gem::Specification.new do |spec|
  spec.name          = "ruby-readability"
  spec.version       = '0.7.0'
  spec.authors       = ["Andrew Cantino", "starrhorne", "libc"]
  spec.summary       = "A tool for extracting the primary readable content of a webpage."
  spec.description   = "Ruby Readability is a tool for extracting the primary readable content of a webpage. It is a Ruby port of arc90's readability project."
  spec.homepage      = "https://github.com/cantino/ruby-readability"
  spec.license       = "Apache-2.0"
 
  spec.files         = `git ls-files`.split($/)
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]
 
  spec.add_development_dependency "bundler", "~> 1.3"
  spec.add_development_dependency "rake"
  spec.add_development_dependency "rspec"
end