README.rdoc in serious-0.2.1 vs README.rdoc in serious-0.2.2
- old
+ new
@@ -57,10 +57,11 @@
serious_blog/
- articles
- articles/2010-02-14-will-you-be-my-valentine.txt
- config.ru
- .gems
+ - Rakefile
The config.ru is pretty straight-forward if you want to stick to the defaults:
require 'serious'
Serious.set :title, "My Sweet Little Blog"
@@ -68,41 +69,67 @@
Serious.set :url, 'http://mysweetlittleblog.heroku.com'
run Serious
The .gems file if you want to host on heroku:
- stupid_formatter
serious
Note that sinatra is not included in the gemfile since heroku has it installed by default, but serious
will install it as a gem dependency on other systems as well.
+The Rakefile, which is obviously totally optional but highly recommended.
+
+ require 'serious'
+ require 'serious/tasks'
+
== Creating heroku app manually
Assuming you've got the heroku gem installed and set up and you've set up git for your blog with
<code>git init</code> or sticked with the generator, which created your git repo, you can now do:
heroku create mysweetlittleblog
git push heroku master
Point your browser to the url, and bang, you're ready!
-== Running with thin
+== Running locally
-You might also want to test your blog locally or host it with thin.
-Use thin (<code>sudo gem install thin</code>) with:
+You might also want to test your blog locally. Use the <code>rake server</code> command inside
+your site's directory.
+You can also use thin (<code>sudo gem install thin</code>) with:
+
thin -R config.ru start
Go to <code>localhost:3000</code> and enjoy.
== Archives
The whole archives can be accessed at <code>/archives</code>. Archives by year, month and date
are available at <code>/2009</code> (all of 2009), <code>/2009/05</code> (May 2009),
<code>/2009/05/15</code> (May 15th 2009).
+== Rake tasks
+
+If you've set up the Rakefile in your site's main directory like mentioned above (this happens
+automatically when generating with the <code>serious</code> executable), you have the following
+tasks available:
+
+ rake article:create # Creates a new article
+ rake article:validate # Validates all articles, making sure they can be processed correctly
+ rake server # Runs a server hosting your site on localhost:3000 using rackup
+
+The default is article:create, so to create a new article, just type <code>rake</code>,
+specify your title and optionally a date and you're ready to go!
+
+It's highly recommended that you run the <code>article:validate</code> task before publishing,
+since it will make sure everything gets processed correctly.
+
+Please be aware that you have to run the Rake tasks from the top level directory (where your
+<code>config.ru</code> file resides) since the config.ru file will be loaded to reflect your
+settings.
+
== Comments with disqus
You can activate comments for articles very easily with disqus (http://disqus.com) by setting
the <code>disqus</code> property to your disqus-id (e.g. 'myfancysite'). Disqus developer mode will
be automatically activated for requests served by http://localhost so you can preview your settings
@@ -265,11 +292,10 @@
* static pages
* make summary delim configurable
* make caching better
* make it possible to host in subdirectories
* valid xhtml in demo setup
-* rake tasks for generating new posts and validating existing
* allow for choice between erb/haml templates
== Note on Patches/Pull Requests
* Fork the project.
@@ -277,9 +303,15 @@
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
+
+== Font credits
+
+The fonts supplied with the gem and used by the default theme are Yanone Kaffeesatz
+(http://www.fonts.info/info/en_yanone-kaffeesatz.htm) and Vollkorn (http://friedrichalthausen.de/2006/01/01/vollkorn/),
+licensed under Creative Commons Attribution 2.0 Generic (http://creativecommons.org/licenses/by/2.0/).
== Thanks
Alexis Sellier for toto, the main inspiration for this gem
Ryan Bates for the great coderay css