public
Fork of rubys/mars
Description: Yet Another Planet Refactoring
Homepage: http://intertwingly.net/blog/2007/12/19/Yet-Another-Planet-Refactoring
Clone URL: git://github.com/technomancy/mars.git
technomancy (author)
Fri Jun 27 09:15:35 -0700 2008
commit  ba8c737efc5e9123458d085dae8701e32560b971
tree    290b08bb24e8cf523950cd50e966034832c98c6a
parent  0a586b503fd189482796420ada7b11fe3f3e7194
mars / README
100644 62 lines (40 sloc) 2.147 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
= Mars
 
Mars is a feed aggregator!
 
http://intertwingly.net/blog/2007/12/19/Yet-Another-Planet-Refactoring
 
== Installation
 
Most of the prerequisites will be handled by Rubygems. Unfortunately
the latest html5lib package contains a bug that's only fixed in 0.10.1
(currently only in SVN trunk).
 
  $ svn checkout http://html5lib.googlecode.com/svn/trunk/ html5lib
  $ cd html5lib/ruby && rake install_gem
 
TODO: make this gem available somewhere. (Ideally rubyforge, but whatever.)
 
In addition, Mars needs a *working* XML parser (REXML version 3.1.6
won't do). The easiest thing to do is probably to install the ruby
bindings to libxml2. On debian-based systems:
 
  $ sudo apt-get install libxml2-dev && sudo gem install libxml-ruby
 
But you can also get a more recent REXML if you don't have a compiler:
 
  $ svn co http://www.germane-software.com/repos/rexml/trunk/ rexml
  $ export RUBYLIB="/path/rexml/src"
 
== Usage
 
  $ planet $CONFIG_FILE
 
Config files may be in INI or YAML. See test/config.yml for an example.
 
TODO: list required values?
 
== License
 
(The MIT License)
 
Copyright (c) Sam Ruby and contributors
 
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 OR COPYRIGHT HOLDERS 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.