writing up the README

.gitignore

@@ -7,3 +7,5 @@ pkg/
 .rvmrc
 notes.txt
 *buffer
+website/
+wiki/

README.markdown

@@ -0,0 +1,60 @@
+# SoyWiki
+
+soywiki is yet another wiki application.
+
+## Prerequisites
+
+* a recent version of Vim (soywiki is developed against Vim 7.2 and 7.3)
+* a recent version of Ruby (soywiki is developed using Ruby 1.9.2)
+* RubyGems (if Ruby version is older than 1.9)
+
+The current version of soywiki assumes a Unix environment. 
+
+## Installation
+
+    gem install soywiki
+
+Test your installation by typing `soywiki -h`. You should see soywiki's help.
+
+On some systems you may run into a PATH issue, where the system can't find the
+`soywiki` command after installation. Please report this if you encounter this
+problem, and mention what system you're using. You might want to try 
+
+    sudo gem install soywiki
+
+If you ever want to uninstall soywiki from your system, execute this command:
+
+    gem uninstall soywiki
+
+... and all traces of soywiki will removed.
+
+## Starting soywiki
+
+Once you've created the configuration file and (optionally) the contacts file,
+you can start soywiki with
+
+    soywiki
+
+## Using soywiki
+
+You can use `<C-j>` or `,j` from either split window to show the next message.
+You can use `<C-k>` or `,k` to show the previous message. 
+
+
+## Opening hyperlinks and HTML parts in your web browser
+
+When you're reading a message, `,o` opens the first hyperlink in the email
+
+By default, the vmail uses the command `open` or `gnome-open` to launch your
+web browser. In OS X, `open` opens URLs and HTML files in the default web
+browser.  `gnome-open` does the same in the Gnome Linux environment.  You can
+change the command soywiki uses to open a hyperlink by adding this to your
+.vimrc:
+
+    let g:SoyWiki#browser_command = "your browser command here"
+
+If your Vim has `netrw` (`:help netrw`), you can open a hyperlink directly in
+same Vim window by putting the cursor at the beginning of a hyperlink and
+typing `gf`, or `C-w f` if you want to open the webpage in a split window. 
+
+

Rakefile

@@ -5,13 +5,33 @@ require 'json'
 require 'rake'
 require 'rake/testtask'
 require 'bundler'
-# require 'soywiki'
+require 'soywiki'
 
 Bundler::GemHelper.install_tasks
 
-desc "Start Sinatra webapp"
-task :sinatra do
-# TODO
+desc "build and push website"
+task :web do
+  version = Soywiki::VERSION
+  Dir.chdir("website") do
+    puts "updating website"
+    puts `./run.sh #{Soywiki::VERSION}`
+  end
+end
+
+desc "build website locally"
+task :weblocal => :build_webpage do
+  Dir.chdir("website") do
+    `open soywiki.html`
+  end
+end
+
+task :build_webpage do
+  $LOAD_PATH.unshift 'website'
+  require 'gen'
+  Dir.chdir("website") do
+    html = Webpage.generate(Soywiki::VERSION)
+    File.open('soywiki.html', 'w') {|f| f.puts html}
+  end
 end
 
 desc "Run tests"