GitXplorerGitXplorer
b

generation-comics

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Verified
308f414aaba990936137fd20e8adc258bf9ad7ff

Apply several security updates

bbk2204 committed a year ago
Verified
5436c97b258d16d5c9ed65ab426535924386d007

README: document deployment

bbk2204 committed 7 years ago
Verified
e4a169b2878cd9960e143e6d2d9484b7b4426602

README: document configuration

bbk2204 committed 7 years ago
Verified
016c9e068e82356b6a8859112582986bb2d0999b

Update rubocop gem to 0.48.1.

bbk2204 committed 8 years ago
Verified
584c8e868ce49a54dbc7cd6a016bf1239f3f4591

rubocop: use brackets instead of parentheses for %i

bbk2204 committed 8 years ago
Verified
2754b184b3b179ec00308822d7b7d6de951220c4

comics/data: escape links in html_message properly

bbk2204 committed 8 years ago

README

The README file for this repository.

Generation Comics

This is a tool to generate daily feeds automatically. It's designed for handling web comics, but it can handle any daily feed.

== Configuration

Configuration is handled by creating a config.json file in the main directory. An example configuration file can be found in the doc/example directory.

The link field for a comic can accept any pattern which works with strftime(3). The time field expresses a time in GMT.

You will generally want to change the id field in the config section to the URL of your installation. This allows the feeds to generate unique IDs that won't conflict with other installations.

Due to the power of Ruby's in-order hash handling, comics should be listed in the same order as they're listed in the configuration file.

== Deployment

Deployment is the same as for any Rack application. To start a test instance, simply run bundle install and then run bundle exec ruby app/run.rb.

== FAQ

Why did you write this tool?:: I got tired of the link in the Dilbert feed being broken.

What formats does it generate?:: Atom 1.0 and RSS 1.0. Atom is recommended.

Why do you generate XHTML?:: Atom and RSS are XML formats. Generating XML avoids the need for encoding HTML and simplifies the templates significantly.

== License

Generation Comics is licensed under the MIT License. See the LICENSE file for more details.