Permalink
Browse files

improved README

  • Loading branch information...
1 parent 426c8df commit a219cbad74f4cb3f229f6116d8b893c5e0369c62 @georgi committed Sep 7, 2008
Showing with 95 additions and 11 deletions.
  1. +1 −0 .gitignore
  2. +18 −0 LICENSE
  3. +19 −11 README
  4. +56 −0 Rakefile
  5. +1 −0 bin/shinmun
View
@@ -0,0 +1 @@
+*~
View
18 LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2008 Matthias Georgi <http://www.matthias-georgi.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
30 README
@@ -32,29 +32,37 @@ The layout is as following:
* An index page will be generated for recent posts.
-Following is an example folder tree:
+Example folder tree:
+ posts
- + blog.yml
- + about.md
- * 2007
+ * blog.yml
+ * about.md
+ + 2007
+ 2008
+ 9
- + example.md
+ * example.md
+ public
- + index.html
- + about.html
+ * index.html
+ * about.html
+ categories
- + emacs.html
- + ruby.html
+ * emacs.html
+ * ruby.html
+ + controllers
+ * comments.php
+ 2007
+ 2008
+ 9
- + example.html
+ * example.html
+ images
+ stylesheest
+ javascripts
-
+ + templates
+ * feed.rxml
+ * layout.rhtml
+ * page.rhtml
+ * post.rhtml
+ * posts.rhtml
+
== Meta data
View
@@ -0,0 +1,56 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'fileutils'
+
+spec = Gem::Specification.new do |s|
+ s.name = "shinmun"
+ s.version = `git describe`.strip.sub(/-.*/, '')
+ s.platform = Gem::Platform::RUBY
+ s.summary = "a small blog engine"
+
+ s.description = <<-EOF
+Shinmun is a blog engine, which renders text files using a markup
+language like Markdown and a set of templates into static web
+pages. It supports Categories, Archives and RSS Feeds. Commenting can
+be done with some Javascript, PHP and a flat file JSON store.
+EOF
+
+ s.files = `git ls-files`.split("\n")
+ s.bindir = 'bin'
+ s.executables << 'shinmun'
+ s.require_path = 'lib'
+ s.add_dependency 'uuid', '>=2.0.0'
+ s.add_dependency 'BlueCloth', '>=1.0.0'
+ s.add_dependency 'rubypants', '>=0.2.0'
+ s.has_rdoc = true
+ s.extra_rdoc_files = ['README']
+
+ s.author = 'Matthias Georgi'
+ s.email = 'matti.georgi@gmail.com'
+ s.homepage = 'http://shinmun.rubyforge.org'
+ s.rubyforge_project = 'shinmun'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+ p.gem_spec = spec
+ p.need_tar = false
+ p.need_zip = false
+end
+
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+
+ rdoc.options << '--line-numbers' << '--inline-source' <<
+ '--main' << 'README' <<
+ '--title' << 'Shinmun Documentation' <<
+ '--charset' << 'utf-8'
+ rdoc.rdoc_dir = "doc"
+ rdoc.rdoc_files.include 'README'
+ rdoc.rdoc_files.include('lib/shinmun.rb')
+end
View
@@ -1,5 +1,6 @@
#! /usr/bin/env ruby
+require 'rubygems'
require 'shinmun'
Shinmun::Blog.new.write_all

0 comments on commit a219cba

Please sign in to comment.